Skip to main content
Bar

BarItem Members

Provides the functionality of bar elements.

Properties

Name Description
AccessibleDescription Gets or sets the object’s description used by accessibility client applications.
AccessibleName Gets or sets the object’s name used by accessibility client applications.
AccessibleRole Gets or sets the object’s accessible role.
Alignment Gets or sets the horizontal alignment of the bar item’s link(s).
AllowGlyphSkinning Gets or sets whether glyphs for this BarItem should be painted using the text foreground color.
AllowHtmlText Gets or sets whether the BarItem.Caption and BarItem.Description can be formatted using HTML tags.
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.
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.
Appearance Provides access to the appearance settings for the current bar item, applied when the bar item is in the regular state.
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.

BindingContext Gets or sets a BindingContext object that manages data bindings for this BarItem.
Border Gets or sets the border style for links that refer to the current item.
BorderStyle Obsolete. This member is not supported.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Caption The bar item’s caption.
Category Gets or sets a category where the bar item is displayed.
CategoryGuid Gets or sets a globally unique identifier (GUID) that identifies the category where the item is displayed.
CategoryIndex Obsolete. Gets or sets the index of the category to which the current item belongs.
CausesValidation Gets or sets whether data validation is performed on the currently focused control when clicking on the bar item.
Container Gets the IContainer that contains the Component. Inherited from Component.
ContentHorizontalAlignment Gets or sets the horizontal alignment mode for this BarItem‘s content.
DataBindings Provides access to the collection of data bindings for the BarItem.
Description Specifies the bar item’s description.
DescriptionMaxWidth Gets or sets the maximum width of this item’s description. Bar Items display their descriptions in Customization Forms, and inside submenus with the LargeImagesTextDescription draw mode.
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.
Enabled Determines whether the current BarItem is active.
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.
Glyph Gets or sets the item’s image.
GlyphDisabled Gets or sets the image corresponding to the item’s disabled state.
Hint Specifies the bar item’s regular hint.
Id Uniquely identifies the current BarItem.
ImageIndex Gets or sets the index of a small image assigned to the item.
ImageIndexDisabled Gets or sets the index of the image displayed within corresponding links when they are disabled.
ImageOptions Provides access to all properties that allow you to assign and customize an icon for this BarItem.
Images Gets the object which contains images that can be displayed within the current item.
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).

IsAllowHtmlText Gets whether HTML tags can be used to format bar item captions.
IsImageExist Gets whether an image which is associated with the bar item actually exists.
IsLargeImageExist Gets whether a large image which is associated with the bar item actually exists.
ItemAppearance Specifies appearance settings for this item in different states.
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.
ItemInMenuAppearance Specifies appearance settings for this item when it is displayed in a sub-menu or pop-up menu.
ItemShortcut Gets or sets the shortcut used to access the associated links with the keyboard.
LargeGlyph Gets or sets the item’s large image.
LargeGlyphDisabled Gets or sets the large image that corresponds to the item’s disabled state.
LargeImageIndex Gets or sets the index of the large image which is displayed within the item’s link(s).
LargeImageIndexDisabled Gets or sets the index of the large image which is displayed within the disabled item’s link(s).
LargeImages Gets the source of large images.
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.
Links Gets the collection of links to the bar item.
Manager Specifies the BarManager responsible for managing the current item.
MergeOrder Defines the visual position of the bar item after merging bars on a parent MDI form.
MergeType Gets or sets how the item behaves during merge operations in MDI applications.
Name Gets or sets the BarItem‘s name.
OwnFont Obsolete. Specifies the font used to display the captions of links corresponding to this item.
PaintStyle Specifies the style with which to display a specific BarItem within a bar.
RibbonStyle Gets or sets the options that specify the bar item’s possible states within a Ribbon Control.
SearchTags Gets or sets a comma-separated list of keywords by which this bar item can be found using the ribbon search menu.
ShortCut Obsolete. Specifies the shortcut key combination for the current item.
ShortcutKeyDisplayString Gets or sets a custom display string for the shortcut assigned to the item via the BarItem.ItemShortcut property.
ShowInCustomizationForm Gets or sets whether the bar item is visible at runtime in the Customization Window.
ShowItemShortcut Gets or sets whether this BarItem should display its shortcut in sub-menus and pop-up menus.
ShowToolTip Gets or sets whether this item should display its hint when hovered.
Site Gets or sets the ISite of the Component. Inherited from Component.
Size Gets or sets the BarItem‘s size. Not supported in Ribbon UI.
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.
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.
SuperTip Gets or sets a SuperToolTip for the current bar item.
Tag Gets or sets an object that contains data on the current item.
UseOwnFont Obsolete. Gets or sets whether the item’s links are painted using the item’s own font (Appearance.Font).
Visibility Specifies when the item is visible.
VisibleInSearchMenu Gets or sets whether the bar item can be found using the ribbon search menu.
VisibleWhenVertical Determines whether an item is visible when the bar is vertically oriented .
Width When overridden in a derived class, this property specifies the current item width.

Methods

Name Description
BeginUpdate() Locks the BarItem object by preventing visual updates until the EndUpdate method is called.
CancelUpdate() Unlocks the object after it has been locked by the BarItem.BeginUpdate method, without causing an immediate visual update.
ContainsItem(BarItem) Indicates whether the item contains the item specified.
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.
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.
GetBarLinkInfoProvider() This member supports the internal infrastructure, and is not intended to be used directly from your code.
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.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
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() Fires the ItemClick events for the current bar item.
PerformClick(BarItemLink) Fires the ItemClick events for the current bar item and its link.
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.
Reset() Resets the current BarItem to the original state.
ResetDropDownSuperTip() Clears the SuperTip that has been assigned to the BarItem.DropDownSuperTip property.
ResetSuperTip() Removes the SuperToolTip object that has been assigned to the current bar item.
ToString() Returns this BarItem‘s caption (the BarItem.Caption property value).
UpdateBindings(BindingContext) Updates data bindings used by this BarItem.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
HyperlinkClick Occurs each time an end-user clicks a hyperlink within the current BarItem.
ItemClick Occurs when the current item is clicked.
ItemDoubleClick Fires when a link to an item is double-clicked.
ItemPress Fires immediately after a link associated with an item has been pressed.
See Also