The requested page is not available for the requested platform. You are viewing the content for Default platform.

XRDesignBarManager Members

Constructors

Name Description
XRDesignBarManager()

Initializes a new instance of the XRDesignBarManager class with the default settings.

XRDesignBarManager(IContainer)

Initializes a new instance of the XRDesignBarManager class with the specified container.

Properties

Name Description
Gets the link whose editor is currently active.
(Inherited from BarManager)
ActiveEditor Gets the currently active editor.
(Inherited from BarManager)
ActiveMdiChild Gets the currently active multiple document interface (MDI) child window.
(Inherited from BarManager)
AllowCustomization Gets or sets whether the Customization Window can be activated by the end-user.
(Inherited from BarManager)
AllowDisposeItems Gets or sets whether bar items are disposed when removed from the BarManager.Items collection.
(Inherited from BarManager)
AllowFocusPopupForm For internal use.
(Inherited from BarManager)
AllowGlyphSkinning Gets or sets whether glyphs for all BarItems within the BarManager should be painted using the text foreground color.
(Inherited from BarManager)
AllowHtmlText Gets or sets the default ability to use HTML tags to format bar item text (BarItem.Caption and BarItem.Description) within the current BarManager.
(Inherited from BarManager)
AllowItemAnimatedHighlighting Gets or sets whether bar items are highlighted with an animation effect.
(Inherited from BarManager)
AllowLinkLighting Obsolete. Gets or sets a value that specifies whether images are highlighted when links are hot-tracked.
(Inherited from BarManager)
AllowMdiChildButtons Gets or sets whether to show the MDI buttons for the maximized MDI child document.
(Inherited from BarManager)
Gets or sets whether invisible links can be merged.
(Inherited from BarManager)
AllowMoveBarOnToolbar Gets or sets a value indicating whether bar movement within the toolbar area is allowed.
(Inherited from BarManager)
AllowQuickCustomization Gets or sets whether quick bar customization is enabled.
(Inherited from BarManager)
AllowShowToolbarsPopup Gets or sets a value indicating whether bars belonging to the Bar Manager allow the customization menu to be displayed.
(Inherited from BarManager)
AutoSaveInRegistry Gets or sets a value indicating whether the bars' layout is saved to and loaded from the system registry automatically.
(Inherited from BarManager)
BarBackColor Obsolete. Gets or sets the default background color for all bars that belong to the BarManager.
(Inherited from BarManager)
BarInfos

For internal use.

BarItemHorzIndent Obsolete. Gets the horizontal indent between the contents and borders of bar links.
(Inherited from BarManager)
BarItemVertIndent Obsolete. Gets or sets the vertical indent between the content and borders of bar links.
(Inherited from BarManager)
Bars Gets the bars collection of the BarManager component.
(Inherited from BarManager)
CacheItemLinkSize Gets or sets whether or not this BarManager should cache the sizes of its item links.
(Inherited from BarManager)
CanRaiseEvents Gets a value indicating whether the component can raise an event.
(Inherited from Component)
CanShowNonRecentItems This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
(Inherited from BarManager)
Categories Gets a collection of categories used to logically organize bar items.
(Inherited from BarManager)
CloseButtonAffectAllTabs This member is obsolete. It gets or sets a value specifying whether the close button of a dock window hides other windows docked onto it.
(Inherited from BarManager)
CloseEditorOnModalFormShow
(Inherited from BarManager)
ClosePopupOnModalFormShow This member supports the internal infrastructure, and is not intended to be used directly from your code.
(Inherited from BarManager)
Container Gets the IContainer that contains the Component.
(Inherited from Component)
Controller Gets or sets the Bar and Docking Controllers (Customizing Default View and Behavior Settings) that will provide default appearance and customization options for the bars belonging to the current BarManager.
(Inherited from BarManager)
Gets the currently customized link.
(Inherited from BarManager)
DesignMode Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
DockControls Gets the collection of controls that provide docking for bars.
(Inherited from BarManager)
DockManager Gets or sets the DockManager which coordinates any docking operations performed on dock panels.
(Inherited from BarManager)
DockWindowTabFont This member is obsolete. It gets or sets the font used to display tab captions when dock windows are docked to the same place.
(Inherited from BarManager)
DockWindows Obsolete. This member is obsolete. It gets the collection of dock windows within the BarManager component.
(Inherited from BarManager)
DockingEnabled Gets or sets a value indicating whether the BarManager component allows bar docking.
(Inherited from BarManager)
EditorsRepository Obsolete. To customize the collection of editors available for bars, use the inherited ComponentEditorContainer.RepositoryItems or ComponentEditorContainer.ExternalRepository property.
(Inherited from BarManager)
Events Gets the list of event handlers that are attached to this Component.
(Inherited from Component)
ExternalRepository Gets or sets the external editors repository.
(Inherited from ComponentEditorContainer)
FontNameBox

Gets or sets the pop-up box which is used to specify a font name.

FontNameEdit

Gets or sets the editor which is used to specify a font name.

FontSizeBox

Gets or sets the pop-up box which is used to specify a font size.

FontSizeEdit

Gets or sets the editor which is used to specify a font size.

Form Gets or sets the container for bar controls that are managed by the current BarManager.
(Inherited from BarManager)
FormattingToolbar

For internal use. Gets or sets the Formatting Toolbar controlled by this bar manager.

HideBarsWhenMerging Gets or sets whether bars that belong to the current child Bar Manager are hidden from the child form during a merge operation. This option is in effect if you subscribed to the parent BarManager's BarManager.Merge and BarManager.UnMerge events.
(Inherited from BarManager)
HighlightMode Gets or sets the highlight mode for hovered drop-down BarButtonItems. Default to highlight the entire BarButtonItem; Separate to highlight the caption and the drop-down arrow individually.
(Inherited from BarManager)
Gets the currently highlighted link.
(Inherited from BarManager)
HintStaticItem

Gets or sets the object which is used to show hints in the design bar manager.

HtmlImages Gets or sets a collection of images that can be inserted into item captions using the image tag.
(Inherited from BarManager)
ImageStream

Gets or sets a stream which contains the images used to display Design Bar Manager items.

Images

Gets the source of images that can be displayed within items.

IsCustomizing Gets or sets a value indicating whether the BarManager is being customized.
(Inherited from BarManager)
IsDesignMode Gets or sets a value indicating whether the BarManager is in design mode.
(Inherited from BarManager)
IsDocking Gets or sets a value indicating whether a bar is being dragged.
(Inherited from BarManager)
IsDragging Gets or sets a value indicating whether an item link is being dragged.
(Inherited from BarManager)
IsLinkSizing Gets or sets a value indicating whether the BarManager's link is being resized.
(Inherited from BarManager)
IsLoading Gets or sets a value indicating whether the BarManager is being loaded.
(Inherited from BarManager)
IsStoring Gets or sets a value indicating whether the BarManager is being saved to the system registry.
(Inherited from BarManager)
ItemLinkIdCollection This member supports the internal infrastructure, and is not intended to be used directly from your code.
(Inherited from BarManager)
Items Provides access to the BarManager's collection of items.
(Inherited from BarManager)
ItemsFont Obsolete. Gets or sets the default font used to paint link captions.
(Inherited from BarManager)
Gets the link that is currently selected in a bar using the keyboard.
(Inherited from BarManager)
LargeIcons This property is obsolete. Use the BarManagerProperties.LargeIcons property of the DefaultBarAndDockingController or BarAndDockingController object instead.
(Inherited from BarManager)
LargeImages

Overrides the BarManager.LargeImages property.

LayoutToolbar

For internal use. Gets or sets the Layout Toolbar controlled by this bar manager.

LayoutVersion Gets or sets the version of the layout of bars.
(Inherited from BarManager)
MainMenu Gets or sets the main menu bar.
(Inherited from BarManager)
MainMenuBarBackColor Obsolete. Gets or sets the default background color for main menus.
(Inherited from BarManager)
MaxItemId This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
(Inherited from BarManager)
MdiMenuMergeStyle Gets or sets if and when a merge mechanism is invoked in an MDI application.
(Inherited from BarManager)
MenuAnimationType This property is obsolete. Use the BarManagerProperties.MenuAnimationType option of the DefaultBarAndDockingController or BarAndDockingController object instead.
(Inherited from BarManager)
MergedOwner For internal use.
(Inherited from BarManager)
MostRecentItemsPercent Gets or sets the value (as a percentage) that determines which of the menu items that haven't recently been used should be hidden
(Inherited from BarManager)
OpenSubMenuOnHover
(Inherited from BarManager)
OptionsLayout Contains options that control how the bars' layout is stored to/restored from a stream, xml file or system registry.
(Inherited from BarManager)
OptionsStubGlyphs Provides access to options that modify a stub glyphs' appearance.
(Inherited from BarManager)
PaintStyleName Obsolete. Gets or sets the name of the painting style applied to bars.
(Inherited from BarManager)
PopupMenuAlignment Gets or sets how popup menus associated with this BarManager should be aligned.
(Inherited from BarManager)
PopupShowMode Gets or sets whether nested popup sub-menus are displayed in cascaded or inplace mode.
(Inherited from BarManager)
Gets the currently pressed link.
(Inherited from BarManager)
PrimaryShortcutProcessor Gets or sets whether a BarEditItem or an editor within it should process the pressed shortcut.
(Inherited from BarManager)
ProcessShortcutsWhenInvisible Gets or sets whether shortcuts for items are in effect if the Bar Manager belongs to a hidden parent control (Form or UserControl).
(Inherited from BarManager)
ReFocusEditorOnPopupClose Gets or sets whether or not the last focused editor should be focused again after a user has clicked a popup menu item and this menu was closed.
(Inherited from BarManager)
RegistryPath Gets or sets the registry path to which the bar layout is saved.
(Inherited from BarManager)
RepositoryItems Provides access to the component's internal repository.
(Inherited from ComponentEditorContainer)
RightToLeft Gets or sets a value indicating whether the BarManager's elements are aligned to support locales using right-to-left fonts.
(Inherited from BarManager)
SharedImageCollectionImageSizeMode Gets or sets the value that specifies how the display size of images is determined, when the images are obtained from a SharedImageCollection.
(Inherited from BarManager)
ShowCloseButton Gets or sets whether the close button ('x') is displayed at the right edge of the main menu.
(Inherited from BarManager)
ShowFullMenus Gets or sets a value indicating whether to display both recent and non-recent links within a menu.
(Inherited from BarManager)
ShowFullMenusAfterDelay Gets or sets a value indicating whether non-recent item links are displayed after a certain period of time.
(Inherited from BarManager)
ShowScreenTipsInMenus Gets or sets whether bar item link tooltips should be displayed within context menus.
(Inherited from BarManager)
ShowScreenTipsInToolbars Gets or sets whether hints are enabled for bar item links displayed within toolbars.
(Inherited from BarManager)
ShowShortcutInScreenTips Gets or sets a value indicating whether a shortcut key should be displayed along with a hint for links belonging to the BarManager component.
(Inherited from BarManager)
Site Gets or sets the ISite of the Component.
(Inherited from Component)
StatusBar Gets or sets the status bar for the current form.
(Inherited from BarManager)
StatusBarBackColor Obsolete. Gets or sets the background color of the status bar owned by this BarManager.
(Inherited from BarManager)
SubMenuBackColor Obsolete. Gets or sets the default background color for all submenus within the BarManager component.
(Inherited from BarManager)
SubMenuBackgroundImage Obsolete. Gets or sets the default background image for all submenus within the BarManager component.
(Inherited from BarManager)
SubMenuGlyphBackColor Obsolete. Gets or set the background color for item descriptive images.
(Inherited from BarManager)
SubMenuNonRecentGlyphBackColor Obsolete. Gets or set the background color of non-recent item descriptive images.
(Inherited from BarManager)
SubMenuOpenCloseInterval Returns the delay that occurs before a submenu displayed within another submenu is opened or closed, in milliseconds.
(Inherited from BarManager)
SubmenuHasShadow Obsolete. Gets or sets a value indicating whether a submenu casts a shadow.
(Inherited from BarManager)
ToolTipAnchor Gets or sets the point relative to which tooltips are displayed for BarItems within a BarManager. This property is not supported for the RibbonControl.
(Inherited from BarManager)
ToolTipController Gets or sets the component that controls the behavior and appearance of hints displayed for the container component's visual elements.
(Inherited from ComponentEditorContainer)
Toolbar

For internal use. Gets or sets the Main Toolbar controlled by this bar manager.

TransparentEditors This property is provided for backward compatibility. Use the BarManager.TransparentEditorsMode property instead.
(Inherited from BarManager)
TransparentEditorsMode Gets or sets whether specific in-place editors, when focused, are painted using a transparent background color.
(Inherited from BarManager)
UpdateMdiClientOnChildActivate This member supports the internal infrastructure, and is not intended to be used directly from your code.
(Inherited from BarManager)
Updates

For internal use.

UseAltKeyForMenu Gets or sets whether the main menu is activated when the ALT key is pressed.
(Inherited from BarManager)
UseF10KeyForMenu Gets or sets whether the main menu is activated when the F10 key is pressed.
(Inherited from BarManager)
UseSynchronizationContextForMdiCheck
(Inherited from BarManager)
XRDesignPanel

Associates the XRDesignBarManager with the default XRDesignPanel.

ZoomItem

Gets or sets the editor which is used to specify a zoom value for the report's design surface.

Methods

Name Description
About() Activates the About dialog.
(Inherited from BarManager)
BeginInit() Begins the runtime initialization of the BarManager.
(Inherited from BarManager)
BeginUpdate() Locks the BarManager object by preventing visual updates of the object and its elements until the EndUpdate method is called.
(Inherited from BarManager)
CloseMenus() Closes all dropdown and popup windows that belong to this BarManager.
(Inherited from BarManager)
CreateDesignTimeToolbar() This member supports the internal infrastructure, and is not intended to be used directly from your code.
(Inherited from BarManager)
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Customize() Displays the BarManager's Customization Window.
(Inherited from BarManager)
Dispose() Releases all resources used by the Component.
(Inherited from Component)
EndInit()

Notifies the control that initialization has been completed.

EndUpdate() Unlocks the BarManager object after a call to the BeginUpdate method and causes an immediate visual update.
(Inherited from BarManager)
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) Determines whether the specified object instances are considered equal.
(Inherited from Object)
ForceInitialize() Forces the Bar Manager to create bar item links within the BarManager's bars and menus.
(Inherited from BarManager)
ForceLinkCreate() Forces the Bar Manager to create bar item links within the BarManager's bars and menus.
(Inherited from BarManager)
GetBarItemByCommand(CommandID)

Obsolete. Gets a bar item within the bar manager by its command.

GetBarItemImages() Returns the SvgImageCollection that contains default images displayed next to different bar item types in "Add New" menus at design time.
(Inherited from BarManager)
GetBarItemsByReportCommand(ReportCommand)

Gets an array of bar items within the bar manager by their report command.

GetController() Returns the actual Bar and Docking Controllers (Customizing Default View and Behavior Settings) specifying behavior and appearance settings for the corresponding bars.
(Inherited from BarManager)
GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
GetNewBarName() Returns a unique name for a bar which is about to be created.
(Inherited from BarManager)
GetNewItemId() Returns the new unique identifier of an item.
(Inherited from BarManager)
GetPopupContextMenu(Control) Gets the popup menu assigned to a control.
(Inherited from BarManager)
GetService(Type) Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
GetString(BarString) Returns a localized string for the given string identifier.
(Inherited from BarManager)
GetToolTipController() Returns the actual tooltip controller that controls the behavior and appearance of hints for a container component's elements.
(Inherited from ComponentEditorContainer)
GetToolboxType(Bar)

Gets the Toolbox type used by the XRDesignBarManager.

GetType() Gets the Type of the current instance.
(Inherited from Object)
HideCustomization() Hides the Customization Window.
(Inherited from BarManager)
HideToolBarsPopup() Hides the customization menu.
(Inherited from BarManager)
Initialize(XRDesignPanel)

Performs basic initialization of the created XRDesignBarManager object, and assigns the specified Design Panel to it.

InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
InternalGetService(Type) This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
(Inherited from BarManager)
LayoutChanged() Forces the BarManager to repaint itself after you have made certain modifications to its layout.
(Inherited from BarManager)
MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
PerformClick(BarItem) Fires the ItemClick events for the specified bar item.
(Inherited from BarManager)
Fires the ItemClick events for the specified bar item and its link.
(Inherited from BarManager)
ReferenceEquals(Object, Object) Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RegisterCommandHandler(ICommandHandler)

Obsolete. Registers the specified command handler.

ResetStyleDefaults() Obsolete. This method is obsolete. Use the BarAndDockingController.ResetStyleDefaults method of a Bar and Docking Controllers (Customizing Default View and Behavior Settings) to restore style settings which depend on the current paint scheme.
(Inherited from BarManager)
ResetUsageData() Clears the record of menu items recently accessed by a user in their application and restores the default set of visible item controls to menus and bars. This action will not undo any explicit customizations.
(Inherited from BarManager)
RestoreFromRegistry() Restores the bars' layout from the registry.
(Inherited from BarManager)
RestoreFromRegistry(String) Restores the bars' layout from the registry.
(Inherited from BarManager)
RestoreFromStream(Stream) Restores the bars' layout from a stream.
(Inherited from BarManager)
RestoreFromXml(String) Restores the BarManager component state from an xml file.
(Inherited from BarManager)
RestoreLayoutFromRegistry() Restores the bars' layout from the system registry.
(Inherited from BarManager)
RestoreLayoutFromRegistry(String) Restores the bars' layout from the specified system registry path.
(Inherited from BarManager)
RestoreLayoutFromStream(Stream) Restores the bars' layout from the specified stream.
(Inherited from BarManager)
RestoreLayoutFromXml(String) Restores the bars' layout from the specified XML file.
(Inherited from BarManager)
SaveLayoutToRegistry() Saves the bars' layout to the system registry.
(Inherited from BarManager)
SaveLayoutToRegistry(String) Saves the bars' layout to the specified system registry path.
(Inherited from BarManager)
SaveLayoutToStream(Stream) Saves the bars' layout to a stream.
(Inherited from BarManager)
SaveLayoutToXml(String) Saves the bars' layout to an XML file.
(Inherited from BarManager)
SaveToRegistry() Saves the BarManager component state to the system registry.
(Inherited from BarManager)
SaveToRegistry(String) Saves the BarManager component's state to the system registry.
(Inherited from BarManager)
SaveToStream(Stream) Saves the BarManager component's state to a stream.
(Inherited from BarManager)
SaveToXml(String) Saves the BarManager component state to an xml file.
(Inherited from BarManager)
Selects the specified link.
(Inherited from BarManager)
SetCommandVisibility(CommandID, BarItemVisibility)

Obsolete. Changes the visibility of any bar item which executes the specified command.

SetCommandVisibility(CommandID[], BarItemVisibility)

Obsolete. Changes the visibility of any bar item which executes any of the specified commands.

SetPopupContextMenu(Control, PopupMenuBase) Sets the popup menu for a control within a form.
(Inherited from BarManager)
SetToolboxType(Bar, ToolboxType)

Sets the Toolbox type used by the XRDesignBarManager.

ShowToolBarsPopup() Displays the customization menu.
(Inherited from BarManager)
Displays the customization menu at the position of the mouse cursor.
(Inherited from BarManager)
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)
UnregisterCommandHandler(ICommandHandler)

Obsolete. Unregisters the specified command handler.

UpdateLayout() This member supports the internal infrastructure, and is not intended to be used directly from your code.
(Inherited from BarManager)

Events

Name Description
BeforeLoadLayout Occurs before a layout is restored from storage (a stream, xml file or the system registry).
(Inherited from BarManager)
BeforePopup This member supports the internal infrastructure, and is not intended to be used directly from your code.
(Inherited from BarManager)
CloseButtonClick Occurs when a close button ('x') is clicked.
(Inherited from BarManager)
CreateCustomizationForm Occurs before the Customization Window is displayed.
(Inherited from BarManager)
CreateToolbar Allows you to customize a bar when it is created.
(Inherited from BarManager)
CustomDrawItem Allows you to manually paint any BarButtonItemLink within this BarManager.
(Inherited from BarManager)
Disposed Occurs when the component is disposed by a call to the Dispose() method.
(Inherited from Component)
EditorKeyDown Occurs when a key is pressed within an in-place editor that belongs to the container component.
(Inherited from ComponentEditorContainer)
EditorKeyPress Occurs when a character key is pressed within an in-place editor that belongs to the container component.
(Inherited from ComponentEditorContainer)
EditorKeyUp Occurs when a pressed key is released within an in-place editor that belongs to the container component.
(Inherited from ComponentEditorContainer)
EndCustomization Occurs when a user finishes customizing the BarManager.
(Inherited from BarManager)
HighlightedLinkChanged Fires immediately after the highlighted link has been changed.
(Inherited from BarManager)
HyperlinkClick Occurs each time an end-user clicks a hyperlink within the BarManager control.
(Inherited from BarManager)
InitPopup
(Inherited from BarManager)
ItemClick Occurs when a link within the bar is clicked.
(Inherited from BarManager)
ItemDoubleClick Occurs when a link is double clicked.
(Inherited from BarManager)
ItemPress Fires immediately after any of the links associated with the Bar Manager has been pressed.
(Inherited from BarManager)
LayoutUpgrade Occurs after a layout whose version doesn't match the current layout's version has been loaded from storage(a stream, xml file or system registry).
(Inherited from BarManager)
Merge Allows you to customize menus and bars when a child MDI form is activated or maximized (depending on the BarManager.MdiMenuMergeStyle property value).
(Inherited from BarManager)
Popup This member supports the internal infrastructure, and is not intended to be used directly from your code.
(Inherited from BarManager)
PressedLinkChanged Fires immediately after a link has been pressed or released.
(Inherited from BarManager)
QueryShowPopupMenu Occurs when a control's PopupContextMenu is about to appear.
(Inherited from BarManager)
ShortcutItemClick Allows you to stop a bar item's shortcut that has been pressed from being processed by XtraBars.
(Inherited from BarManager)
ShowToolbarsContextMenu Allows you to modify the customization menu before it is displayed onscreen.
(Inherited from BarManager)
StartCustomization Occurs when a user starts customizing the BarManager component.
(Inherited from BarManager)
UnMerge Allows you to customize menus and bars when a child MDI form becomes inactive or when it is restored or minimized from its maximized view (depending on the BarManager.MdiMenuMergeStyle property value).
(Inherited from BarManager)
See Also