Bar

BarToolbarsListItem Members

A bar item that represents a check list of bars owned by a Bar Manager, and dock panels owned by a dock manager.

Constructors

Name Description
BarToolbarsListItem() Initializes a new BarToolbarsListItem class instance.

Properties

Name Description
AccessibleDescription Gets or sets the description of the bar item used by accessibility client applications. Inherited from BarItem.
AccessibleName Gets or sets the bar item's name which is used by accessibility client applications. Inherited from BarItem.
Alignment Gets or sets the horizontal alignment of the item's link(s). Inherited from BarItem.
AllowGlyphSkinning Gets or sets whether glyphs for this BarItem should be painted using the text foreground color. Inherited from BarItem.
AllowHtmlText Gets or sets whether the BarItem.Caption and BarItem.Description can be formatted using HTML tags. Inherited from BarItem.
AllowRightClickInMenu Gets or sets if the current command's functionality is invoked via the right mouse click when in a sub-menu or popup menu. Inherited from BarItem.
AllowSerializeChildren Gets or sets whether or not links contained within this BarLinkContainerItem should be serialized. Inherited from BarLinkContainerItem.
AllowStubGlyph Gets or sets whether or not this item and all its links should display a stub glyph when it has no custom icon assigned. Inherited from BarItem.
Appearance Provides access to the appearance settings for the current bar item, applied when the bar item is in the regular state. Inherited from BarItem.
AppearanceDisabled Provides access to the appearance settings for the current bar item, applied when the bar item is disabled. This property is supported for bar items used within a RibbonControl. Inherited from BarItem.
BackColor Obsolete. Gets or sets the background color of items contained within a BarCustomContainerItem descendant. Inherited from BarCustomContainerItem.
BackgroundImage Obsolete. Gets or sets the background image of items contained within a BarCustomContainerItem descendant. Inherited from BarCustomContainerItem.
BindingContext Gets or sets a BindingContext object that manages data bindings for this BarItem. Inherited from BarItem.
Border Gets or sets the border style for links that refer to the current item. Inherited from BarItem.
BorderStyle Obsolete. Specifies the border style for the current BarItem. Inherited from BarItem.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Caption A string containing the item's caption. Inherited from BarItem.
Category Gets or sets a category where the bar item is displayed. Inherited from BarItem.
CategoryGuid Gets or sets a globally unique identifier (GUID) that identifies the category where the item is displayed. Inherited from BarItem.
CategoryIndex Obsolete. Gets or sets the index of the category to which the current item belongs. Inherited from BarItem.
CausesValidation Gets or sets whether data validation is performed on the currently focused control when clicking on the bar item. Inherited from BarItem.
Container Gets the IContainer that contains the Component. Inherited from Component.
ContentHorizontalAlignment Gets or sets the horizontal alignment mode for this BarItem's content. Inherited from BarItem.
DataBindings Provides access to the collection of data bindings for the BarItem. Inherited from BarItem.
Description Specifies the bar item's description. Inherited from BarItem.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DropDownSuperTip Gets or sets a SuperToolTip object that is displayed when the current item displays a separate dropdown arrow and this arrow is hot-tracked. Inherited from BarItem.
Enabled Determines whether the current BarItem is active. Inherited from BarItem.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Font Gets the font to display links of the current item. Inherited from BarItem.
Glyph Gets or sets the item's image. Inherited from BarItem.
GlyphDisabled Gets or sets the image corresponding to the item's disabled state. Inherited from BarItem.
Hint Specifies the bar item's regular hint. Inherited from BarItem.
Id Uniquely identifies the current BarItem. Inherited from BarItem.
ImageIndex Gets or sets the index of a small image assigned to the item. Inherited from BarItem.
ImageIndexDisabled Gets or sets the index of the image displayed within corresponding links when they are disabled. Inherited from BarItem.
ImageOptions Provides access to all properties that allow you to assign and customize an icon for this BarItem. Inherited from BarItem.
Images Gets the object which contains images that can be displayed within the current item. Inherited from BarItem.
ImageUri Gets or sets a uniform resource identifier of an image from the DX Image Gallery displayed in the current item. An A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size). Inherited from BarItem.
IsAllowHtmlText Gets whether HTML tags can be used to format bar item captions. Inherited from BarItem.
IsImageExist Gets whether an image which is associated with the bar item actually exists. Inherited from BarItem.
IsLargeImageExist Gets whether a large image which is associated with the bar item actually exists. Inherited from BarItem.
ItemAppearance Provides appearance settings used to paint links to the current BarItem object when the links are in different visual states. Inherited from BarItem.
ItemClickFireMode Gets or sets when the Click events for the bar item fire, immediately or asynchronously, after all events in the system event queue are processed. Inherited from BarItem.
ItemInMenuAppearance Provides appearance settings used to paint links to the current BarItem in different visual states when they are displayed within a sub-menu or popup menu. Inherited from BarItem.
ItemLinks Provides access to the links owned and displayed by the container item.
ItemShortcut Gets or sets the shortcut used to access associated links using the keyboard. Inherited from BarItem.
LargeGlyph Gets or sets the item's large image. Inherited from BarItem.
LargeGlyphDisabled Gets or sets the large image that corresponds to the item's disabled state. Inherited from BarItem.
LargeImageIndex Gets or sets the index of the large image which is displayed within the item's link(s). Inherited from BarItem.
LargeImageIndexDisabled Gets or sets the index of the large image which is displayed within the disabled item's link(s). Inherited from BarItem.
LargeImages Gets the source of large images. Inherited from BarItem.
LargeWidth Gets or sets the width of links corresponding to the current item, when they are painted using the RibbonItemStyles.Large paint style. This property is in effect for bar item links displayed within the Ribbon Control and RibbonStatusBar controls. Inherited from BarItem.
Links Gets the collection of links to the item. Inherited from BarItem.
LinksPersistInfo This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
Manager Specifies the BarManager responsible for managing the current item. Inherited from BarItem.
MenuAppearance Provides access to style settings for links owned by the current container item. Inherited from BarCustomContainerItem.
MenuBarWidth Gets or sets the width of the bar displayed to the left of the sub-menu. Inherited from BarCustomContainerItem.
MenuCaption Gets or sets a caption displayed when the current object's items are represented as a popup menu. Inherited from BarCustomContainerItem.
MenuDrawMode Gets or sets the menu's display mode. Inherited from BarCustomContainerItem.
MergeOrder Defines the visual position of the bar item after merging bars on a parent MDI form. Inherited from BarItem.
MergeType Gets or sets how the item behaves during merge operations in MDI applications. Inherited from BarItem.
MultiColumn Gets or sets whether the sub-menu items are displayed in multiple columns. Inherited from BarLinkContainerItem.
Name Gets or sets the BarItem's name. Inherited from BarItem.
OptionsMultiColumn Provides access to the settings of the multicolumn mode of displaying items in the current sub-menu. Inherited from BarLinkContainerItem.
OwnFont Obsolete. Specifies the font used to display the captions of links corresponding to this item. Inherited from BarItem.
PaintStyle Specifies the style with which to display a specific BarItem within a bar. Inherited from BarItem.
RibbonStyle Gets or sets the options that specify the bar item's possible states within a Ribbon Control. Inherited from BarItem.
SearchTags Gets or sets a comma-separated list of keywords by which this bar item can be found using the ribbon search menu. Inherited from BarItem.
ShortCut Obsolete. Specifies the shortcut key combination for the current item. Inherited from BarItem.
ShortcutKeyDisplayString Gets or sets a custom display string for the shortcut assigned to the item via the BarItem.ItemShortcut property. Inherited from BarItem.
ShowCustomizationItem Gets or sets a value indicating whether "Customize..." is among the item's subitems list.
ShowDockPanels Gets or sets whether a list of the existing dock panels should be displayed.
ShowDockWindows Obsolete. Determines whether to display the list of existing dock windows within a specific BarToolbarsListItem.
ShowInCustomizationForm Gets or sets whether the bar item is visible at runtime in the Customization Window. Inherited from BarItem.
ShowItemShortcut Gets or sets whether this BarItem should display its shortcut in sub-menus and pop-up menus. Inherited from BarItem.
ShowMenuCaption Gets or sets whether the menu header is visible when the current object's items are displayed as a popup menu. Inherited from BarCustomContainerItem.
ShowNavigationHeader Gets or sets whether the navigation header that provides navigation through the menu hierarchy, is shown at the top of the current BarCustomContainerItem. This property is in effect when the current BarCustomContainerItem is displayed in the Inplace popup show mode. Inherited from BarCustomContainerItem.
ShowToolbars Determines whether to display the list of existing toolbars within a specific BarToolbarsListItem.
Site Gets or sets the ISite of the Component. Inherited from Component.
Size Gets or sets the BarItem's size. Inherited from BarItem.
SmallWithoutTextWidth Gets or sets the width of links corresponding to the current item, when they are painted using the RibbonItemStyles.SmallWithoutText paint style. This property is in effect for bar item links displayed within the Ribbon Control and RibbonStatusBar controls. Inherited from BarItem.
SmallWithTextWidth Gets or sets the width of links corresponding to the current item, when they are painted using the RibbonItemStyles.SmallWithText paint style. This property is in effect for bar item links displayed within the Ribbon Control and RibbonStatusBar controls. Inherited from BarItem.
SuperTip Gets or sets a SuperToolTip for the current bar item. Inherited from BarItem.
Tag Gets or sets an object that contains data on the current item. Inherited from BarItem.
UseOwnFont Obsolete. Gets or sets whether the item's links are painted using the item's own font (Appearance.Font). Inherited from BarItem.
Visibility Specifies when the item is visible. Inherited from BarItem.
VisibleInSearchMenu Gets or sets whether the bar item can be found using the ribbon search menu. Inherited from BarItem.
VisibleWhenVertical Determines whether an item is visible when the bar is vertically oriented . Inherited from BarItem.
Width When overridden in a derived class, this property specifies the current item width. Inherited from BarItem.

Methods

Name Description
AddItem(BarItem) Adds another link to the BarLinkContainerItem. Inherited from BarLinkContainerItem.
AddItems(BarItem[]) Adds links to an array of items. Inherited from BarLinkContainerItem.
BeginUpdate() Locks the BarItem object by preventing visual updates until the EndUpdate method is called. Inherited from BarItem.
CancelUpdate() Unlocks the object after it has been locked by the BarItem.BeginUpdate method, without causing an immediate visual update. Inherited from BarItem.
ClearLinks() Removes all links from the BarLinkContainerItem control. Inherited from BarLinkContainerItem.
ContainsItem(BarItem) Returns whether the current container item owns the link which refers to the specified item. Inherited from BarCustomContainerItem.
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.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndUpdate() Unlocks the BarItem object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BarItem.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetBarLinkInfoProvider() This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BarItem.
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.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
GetVisibleLinks() Returns the list of all currently visible links to this BarItem. Inherited from BarItem.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InsertItem(BarItemLink, BarItem) Inserts a link in the BarLinkContainerItem at the specified index. Inherited from BarLinkContainerItem.
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.
Merge(BarLinkContainerItem) Adds the subitems of the specified container item to the current container item. Inherited from BarLinkContainerItem.
PerformClick() Fires the ItemClick events for the current bar item. Inherited from BarItem.
PerformClick(BarItemLink) Fires the ItemClick events for the current bar item and its link. Inherited from BarItem.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh() Forces the controls that contain the bar item's links to invalidate their client area. Inherited from BarItem.
RemoveLink(BarItemLink) Removes the first occurrence of a specific link from the BarLinkContainerItem. Inherited from BarLinkContainerItem.
Reset() Returns the BarLinkContainerItem to its precompiled state. Inherited from BarLinkContainerItem.
ResetDropDownSuperTip() Clears the SuperTip that has been assigned to the BarItem.DropDownSuperTip property. Inherited from BarItem.
ResetSuperTip() Removes the SuperToolTip object that has been assigned to the current bar item. Inherited from BarItem.
SetCurrentStateAsDefault() This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from BarLinkContainerItem.
ToString() Returns this BarItem's caption (the BarItem.Caption property value). Inherited from BarItem.
UnMerge() Restores the original layout of subitems for the container item after a previous merge operation. Inherited from BarLinkContainerItem.
UpdateBindings(BindingContext) Updates data bindings used by this BarItem. Inherited from BarItem.

Events

Name Description
CloseUp Occurs when an item submenu closes. Inherited from BarCustomContainerItem.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
GetItemData Allows you to provide child items for the current BarCustomContainerItem object, or to customize the existing child items. Inherited from BarCustomContainerItem.
HyperlinkClick Occurs each time an end-user click a hyperlink within the current BarItem. Inherited from BarItem.
ItemClick Occurs when the current item is clicked. Inherited from BarItem.
ItemDoubleClick Fires when a link to an item is double-clicked. Inherited from BarItem.
ItemPress Fires immediately after a link associated with an item has been pressed. Inherited from BarItem.
LinkAdded Fires immediately after a link has been added to the sub links collection. Inherited from BarLinkContainerItem.
LinkDeleted Fires immediately after a link has been removed from the sub links collection. Inherited from BarLinkContainerItem.
PaintMenuBar Enables you to paint the content of the bar displayed to the left of the sub-menu. Inherited from BarCustomContainerItem.
Popup Occurs when an item's submenu pops up. Inherited from BarCustomContainerItem.
See Also