BarManager Members

The component that manages traditional bars and popup menus.

Constructors

Name	Description
BarManager()	Initializes a new BarManager class instance.
BarManager(IContainer)	Initializes a new instance of the BarManager class with the specified container.

Name	Description
ActiveEditItemLink	Gets the link whose editor is currently active.
ActiveEditor	Gets the currently active editor.
ActiveMdiChild	Gets the currently active multiple document interface (MDI) child window.
AllowCustomization	Gets or sets whether the Customization Window can be activated by the end-user.
AllowDisposeItems	Gets or sets whether bar items are disposed when removed from the BarManager.Items collection.
AllowFocusBarWithoutMainMenu	Gets or sets whether you can activate bars when their bar manager does not contain a main menu.
AllowFocusPopupForm static	For internal use.
AllowGlyphSkinning	Gets or sets whether glyphs for all BarItems within the BarManager should be painted using the text foreground color.
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.
AllowItemAnimatedHighlighting	Gets or sets whether bar items are highlighted with an animation effect.
AllowLinkLighting	Obsolete. Gets or sets a value that specifies whether images are highlighted when links are hot-tracked.
AllowMdiChildButtons	Gets or sets whether to show the MDI buttons for the maximized MDI child document.
AllowMergeInvisibleLinks	Gets or sets whether invisible links can be merged.
AllowMoveBarOnToolbar	Gets or sets a value indicating whether bar movement within the toolbar area is allowed.
AllowQuickCustomization	Gets or sets whether quick bar customization is enabled.
AllowShowToolbarsPopup	Gets or sets a value indicating whether bars belonging to the Bar Manager allow the customization menu to be displayed.
AutoSaveInRegistry	Gets or sets a value indicating whether the bars’ layout is saved to and loaded from the system registry automatically.
BarBackColor	Obsolete. Gets or sets the default background color for all bars that belong to the BarManager.
BarItemHorzIndent	Obsolete. Gets the horizontal indent between the contents and borders of bar links.
BarItemVertIndent	Obsolete. Gets or sets the vertical indent between the content and borders of bar links.
Bars	Gets the bars collection of the BarManager component.
CacheItemLinkSize static	Gets or sets whether or not this BarManager should cache the sizes of its item links.
CanRaiseEvents protected	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.
Categories	Gets a collection of categories used to logically organize bar items.
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.
CloseEditorOnModalFormShow static	This is an internal property that should not be used.
ClosePopupOnModalFormShow static	This member supports the internal infrastructure, and is not intended to be used directly from your code.
CloseSubMenusOnMouseLeave
Container	Gets the IContainer that contains the Component. Inherited from Component.
Controller	Gets or sets the bar and dock controller that will provide default appearance and customization options for the bars belonging to the current BarManager.
CustomizeSelectedLink	Gets the currently customized link.
DesignMode protected	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.
DockingEnabled	Gets or sets a value indicating whether the BarManager component allows bar docking.
DockManager	Gets or sets the DockManager which coordinates any docking operations performed on dock panels.
DockWindows	Obsolete. This member is obsolete. It gets the collection of dock windows within the BarManager component.
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.
EditorsRepository	Obsolete. To customize the collection of editors available for bars, use the inherited ComponentEditorContainer.RepositoryItems or ComponentEditorContainer.ExternalRepository property.
Events protected	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.
Form	Gets or sets the Form or UserControl that bars are on.
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.
HighlightedLink	Gets the currently highlighted link.
HighlightMode static	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.
HtmlImages	Gets or sets a collection of images that can be inserted into item captions using the image tag.
Images	Gets or sets the source of images that can be displayed within item links.
IsCustomizing	Gets or sets a value indicating whether the BarManager is being customized.
IsDesignMode	Gets or sets a value indicating whether the BarManager is in design mode.
IsDocking	Gets or sets a value indicating whether a bar is being dragged.
IsDragging	Gets or sets a value indicating whether an item link is being dragged.
IsLinkSizing	Gets or sets a value indicating whether the BarManager‘s link is being resized.
IsLoading	Gets or sets a value indicating whether the BarManager is being loaded.
IsStoring	Gets or sets a value indicating whether the BarManager is being saved to the system registry.
ItemLinkIdCollection	This member supports the internal infrastructure, and is not intended to be used directly from your code.
Items	Provides access to the BarManager’s collection of items.
ItemsFont	Obsolete. Gets or sets the default font used to paint link captions.
KeyboardHighlightedLink	Gets the link that is currently selected in a bar using the keyboard.
LargeIcons	This property is obsolete. Use the BarManagerProperties.LargeIcons property of the DefaultBarAndDockingController or BarAndDockingController object instead.
LargeImages	Gets or sets the source of large images that can be displayed within item links.
LayoutVersion	Gets or sets the version of the layout of bars.
MainMenu	Gets or sets the bar that is used as the form’s main menu.
MainMenuBarBackColor	Obsolete. Gets or sets the default background color for main menus.
MaxItemId	This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
MdiMenuMergeStyle	Gets or sets if and when a merge mechanism is invoked in an MDI application.
MenuAnimationType	This property is obsolete. Use the BarManagerProperties.MenuAnimationType option of the DefaultBarAndDockingController or BarAndDockingController object instead.
MergedOwner	For internal use.
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
OpenSubMenuOnHover static	Gets or sets whether sub-menus are automatically opened when hovered over with the mouse pointer.
OptionsLayout	Contains options that control how the bars’ layout is stored to/restored from a stream, xml file or system registry.
OptionsStubGlyphs	Provides access to options that modify a stub glyphs’ appearance.
PaintStyleName	Obsolete. Gets or sets the name of the painting style applied to bars.
PopupMenuAlignment	Gets or sets how popup menus associated with this BarManager should be aligned.
PopupShowMode	Gets or sets whether nested popup sub-menus are displayed in cascaded or inplace mode.
PressedLink	Gets the currently pressed link.
PrimaryShortcutProcessor	Gets or sets whether a BarEditItem or an editor within it should process the pressed shortcut.
ProcessShortcutsWhenInvisible	Gets or sets whether shortcuts for items are in effect if the Bar Manager belongs to a hidden parent control (Form or UserControl).
ReFocusEditorOnPopupClose static	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.
RegistryPath	Gets or sets the registry path to which the bar layout is saved.
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.
SharedImageCollectionImageSizeMode	Gets or sets the value that specifies how the display size of images is determined, when the images are obtained from a SharedImageCollection.
ShowCloseButton	Gets or sets whether the close button is displayed in the main menu.
ShowFullMenus	Gets or sets a value indicating whether to display both recent and non-recent links within a menu.
ShowFullMenusAfterDelay	Gets or sets a value indicating whether non-recent item links are displayed after a certain period of time.
ShowScreenTipsInMenus	Gets or sets whether bar item link tooltips should be displayed within context menus.
ShowScreenTipsInToolbars	Gets or sets whether hints are enabled for bar item links displayed within toolbars.
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.
SingleTapToShowKeyboard	Gets or sets whether users should tap editors once or twice to display the on-screen keyboard (when the application runs on touch-screen devices).
Site	Gets or sets the ISite of the Component. Inherited from Component.
StatusBar	Gets or sets the status bar for the current form.
StatusBarBackColor	Obsolete. Gets or sets the background color of the status bar owned by this BarManager.
SubMenuBackColor	Obsolete. Gets or sets the default background color for all submenus within the BarManager component.
SubMenuBackgroundImage	Obsolete. Gets or sets the default background image for all submenus within the BarManager component.
SubMenuGlyphBackColor	Obsolete. Gets or set the background color for item descriptive images.
SubmenuHasShadow	Obsolete. Gets or sets a value indicating whether a submenu casts a shadow.
SubMenuNonRecentGlyphBackColor	Obsolete. Gets or set the background color of non-recent item descriptive images.
SubMenuOpenCloseInterval	Returns the delay that occurs before a submenu displayed within another submenu is opened or closed, in milliseconds.
SuppressModifierKey	Gets or sets whether to suppress the specified keyboard key for all editors.
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.
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.
TransparentEditors	This property is provided for backward compatibility. Use the BarManager.TransparentEditorsMode property instead.
TransparentEditorsMode	Gets or sets whether specific in-place editors, when focused, are painted using a transparent background color.
UpdateMdiClientOnChildActivate static	This member supports the internal infrastructure, and is not intended to be used directly from your code.
UseAltKeyForMenu	Gets or sets whether the main menu is activated when the ALT key is pressed.
UseF10KeyForMenu	Gets or sets whether the main menu is activated when the F10 key is pressed.
UseSynchronizationContextForMdiCheck static	This property supports internal infrastructure and is not intended to be used in code.

Name	Description
About() static	Activates the About dialog.
BeginInit()	Begins the runtime initialization of the BarManager.
BeginUpdate()	Locks the BarManager object by preventing visual updates of the object and its elements until the EndUpdate method is called.
CloseMenus()	Closes all dropdown and popup windows that belong to this BarManager.
CreateDesignTimeToolbar()	This member supports the internal infrastructure, and is not intended to be used directly from your code.
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()	Invokes the Customization Form.
Dispose()	Releases all resources used by the Component. Inherited from Component.
EndInit()	Notifies the component that the initialization has been completed. Inherited from ComponentEditorContainer.
EndUpdate()	Unlocks the BarManager object after a call to the BeginUpdate method and causes an immediate visual update.
Equals(Object, Object) static	Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)	Determines whether the specified object is equal to the current object. Inherited from Object.
ForceInitialize()	Forces the Bar Manager to create bar item links within the BarManager’s bars and menus.
ForceLinkCreate()	Forces the manager to create item links based on bar items.
GetBarItemImages()	Returns the SvgImageCollection that contains default images displayed next to different bar item types in “Add New” menus at design time.
GetController()	Returns the actual bar and dock controller specifying behavior and appearance settings for the corresponding bars.
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.
GetNewItemId()	This method is intended for internal use. Returns the new unique identifier of an item.
GetPopupContextMenu(Control)	Gets the popup menu assigned to a control.
GetService(Type) protected	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.
GetToolTipController()	Returns the actual tooltip controller that controls the behavior and appearance of hints for a container component’s elements. Inherited from ComponentEditorContainer.
GetType()	Gets the Type of the current instance. Inherited from Object.
HideCustomization()	Hides the Customization Window.
HideToolBarsPopup()	Hides the customization menu.
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.
LayoutChanged()	Forces the BarManager to repaint itself after you have made certain modifications to its layout.
LockFireChanged()	This is an internal method. Do not call it in your code.
MemberwiseClone() protected	Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected	Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
PerformClick(BarItem, BarItemLink)	Fires the ItemClick events for the specified bar item and its link.
PerformClick(BarItem)	Fires the ItemClick events for the specified bar item.
ReferenceEquals(Object, Object) static	Determines whether the specified Object instances are the same instance. Inherited from Object.
ResetStyleDefaults()	Obsolete. This method is obsolete. Use the BarAndDockingController.ResetStyleDefaults method of a bar and dock controller to restore style settings which depend on the current paint scheme.
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.
RestoreFromRegistry()	Restores the bars’ layout from the registry.
RestoreFromRegistry(String)	Restores the bars’ layout from the registry.
RestoreFromStream(Stream)	Restores the bars’ layout from a stream.
RestoreFromXml(String)	Restores the BarManager component state from an xml file.
RestoreLayoutFromRegistry()	Restores the bars’ layout from the system registry.
RestoreLayoutFromRegistry(String)	Restores the bars’ layout from the specified system registry path.
RestoreLayoutFromStream(Stream)	Restores the bars’ layout from the specified stream.
RestoreLayoutFromXml(String)	Restores the bars’ layout from the specified XML file.
SaveLayoutToRegistry()	Saves the bars’ layout to the system registry.
SaveLayoutToRegistry(String)	Saves the bars’ layout to the specified system registry path.
SaveLayoutToStream(Stream)	Saves the bars’ layout to a stream.
SaveLayoutToXml(String)	Saves the bars’ layout to an XML file.
SaveToRegistry()	Saves the BarManager component state to the system registry.
SaveToRegistry(String)	Saves the BarManager component’s state to the system registry.
SaveToStream(Stream)	Saves the BarManager component’s state to a stream.
SaveToXml(String)	Saves the BarManager component state to an xml file.
SelectLink(BarItemLink)	Selects the specified link.
SetPopupContextMenu(Control, PopupMenuBase)	Sets the popup menu for a control within a form.
ShowCustomizationForm()	Invokes the Customization Form.
ShowToolBarsPopup()	Displays the customization menu.
ShowToolBarsPopup(BarItemLink)	Displays the customization menu at the position of the mouse cursor.
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
UnlockFireChanged()	This is an internal method. Do not call it in your code.
UpdateLayout()	This member supports the internal infrastructure, and is not intended to be used directly from your code.

Name	Description
BeforeLoadLayout	Occurs before a layout is restored from storage (a stream, xml file or the system registry).
BeforePopup	This member supports the internal infrastructure, and is not intended to be used directly from your code.
CloseButtonClick	Fires when the close button is clicked.
CreateCustomizationForm	Occurs before the Customization Window is displayed.
CreateToolbar	Allows you to customize a bar when it is created.
CustomDrawItem	Allows you to manually paint bar item links.
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.
HighlightedLinkChanged	Fires immediately after the highlighted link has been changed.
HyperlinkClick	Occurs each time an end-user clicks a hyperlink within the BarManager control.
InitPopup	This is an internal event that should not be used.
ItemClick	Occurs when a link within the bar is clicked.
ItemDoubleClick	Occurs when a link is double clicked.
ItemPress	Fires immediately after any of the links associated with the Bar Manager has been pressed.
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).
Load	Fires when the manager is initialized.
Merge	Allows you to customize menus and bars when a child MDI form is activated or maximized (depending on the BarManager.MdiMenuMergeStyle property value).
Popup	This member supports the internal infrastructure, and is not intended to be used directly from your code.
PressedLinkChanged	Fires immediately after a link has been pressed or released.
QueryShowPopupMenu	Occurs when a control’s PopupContextMenu is about to appear.
ShortcutItemClick	Allows you to stop a bar item’s shortcut that has been pressed from being processed by XtraBars.
ShowToolbarsContextMenu	Allows you to modify the customization menu before it is displayed onscreen.
StartCustomization	Occurs when a user starts customizing the BarManager component.
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).

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

BarManager Members

Constructors

Properties

Methods

Events