Bar

BarButtonItem Members

Represents a toolbar button or menu item.

Constructors

Name Description
BarButtonItem() Initializes a new BarButtonItem class instance .
BarButtonItem(BarManager, String) Creates a new instance of the BarButtonItem class.
BarButtonItem(BarManager, String, Int32) Creates a new instance of the BarButtonItem class.
BarButtonItem(BarManager, String, Int32, BarShortcut) Creates a new instance of the BarButtonItem class.

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.
ActAsDropDown Gets or sets whether this BarButtonItem should be displayed as a single element. This property is in effect when the BarButtonItem.ButtonStyle property is set to BarButtonStyle.DropDown.
Alignment Gets or sets the horizontal alignment of the item's link(s). Inherited from BarItem.
AllowAllUp Gets or sets whether all the button items in a group can be in the normal (elevated) state at a time. Inherited from BarBaseButtonItem.
AllowDrawArrow Gets or sets whether an arrow for the pop-up button should be displayed.
AllowDrawArrowInMenu Gets or sets whether the drop-down BarButtonItem should display an arrow in menus.
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.
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.
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.
ButtonStyle Get or sets the button item's style which determines how the current bar button item functions.
CanDown Gets a value indicating whether the button item has two states (normal and pressed). Inherited from BarBaseButtonItem.
CanPressDropDownButton Gets a value indicating whether the Dropdown button of the BarButtonItem component can be pressed.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Caption Gets or sets the BarButtonItem's caption.
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.
CloseOwnerMenuOnlyOnClick Gets or sets whether only the submenu owning the current button is closed on a click, but not precedent submenus. Inherited from BarBaseButtonItem.
CloseRadialMenuOnItemClick Gets or sets whether clicking the current BarButtonItem's link within a RadialMenu should close this menu.
CloseSubMenuOnClick Gets or sets whether a submenu which contains the button item's link is closed when the link is clicked. Inherited from BarBaseButtonItem.
CloseSubMenuOnClickMode Gets or sets whether a click on the button closes the submenu that contains this button. Inherited from BarBaseButtonItem.
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 Gets or sets the BarButtonItem's description.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Down Gets or sets a value indicating whether the button item is pressed down. Inherited from BarBaseButtonItem.
DropDownControl Gets or sets a Dropdown control for the BarButtonItem component.
DropDownEnabled Gets or sets a value indicating whether a dropdown control, assigned to the BarButtonItem.DropDownControl property, is enabled.
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 BarButtonItem's regular icon.
GlyphDisabled Gets or sets a regular icon for the disabled BarButtonItem.
GroupIndex Gets or sets the button's group index. This property is in effect when the current object acts as a check button. Inherited from BarBaseButtonItem.
Hint Specifies the bar item's regular hint.
Id Uniquely identifies the current BarItem. Inherited from BarItem.
ImageIndex Gets or sets the index of a regular icon assigned to the BarButtonItem.
ImageIndexDisabled Gets or sets the index of the image displayed within corresponding links when they are disabled. Inherited from BarItem.
ImageOptions Provides access to properties that affect this button's icon.
Images Gets the object which contains images that can be displayed within the current item. Inherited from BarItem.
ImageToTextAlignment Specifies whether the bar item image should go before or after this item caption. Inherited from BarBaseButtonItem.
ImageUri Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current item. 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. 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.
ItemShortcut Gets or sets the shortcut used to access associated links using the keyboard. Inherited from BarItem.
LargeGlyph Gets or sets the BarButtonItem's large icon.
LargeGlyphDisabled Gets or sets the large icon for the disabled BarButtonItem.
LargeImageIndex Gets or sets the index of a large icon assigned to the BarButtonItem.
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.
Manager Specifies the BarManager responsible for managing the current item. Inherited from BarItem.
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.
Name Gets or sets the BarItem's name. Inherited from BarItem.
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.
RememberLastCommand Gets or sets whether the current Split Button should repeat the last selected command from its drop-down when clicked.
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.
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.
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 the Super Tip for the current BarButtonItem.
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
BeginUpdate() Locks the BarItem object by preventing visual updates until the EndUpdate method is called. Inherited from BarItem.
BindCommand(Expression<Action>, Object, Func<Object>) Uses the command selector to find an appropriate parameterized command in the source and bind it to this BarButtonItem.
BindCommand(Object, Func<Object>) Binds the specific parameterized command to this BarButtonItem.
BindCommand<T>(Expression<Action<T>>, Object, Func<T>) Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this BarButtonItem.
CancelUpdate() Unlocks the object after it has been locked by the BarItem.BeginUpdate method, without causing an immediate visual update. Inherited from BarItem.
ContainsItem(BarItem) Indicates whether the item contains the item specified. Inherited from BarItem.
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.
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. 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.
Reset() Resets the current BarItem to the original state. Inherited from BarItem.
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.
Toggle() Toggles the button item's state. Inherited from BarBaseButtonItem.
Toggle(BarItemLink) Toggles the button item's (link's) state. Inherited from BarBaseButtonItem.
ToString() Returns this BarItem's caption (the BarItem.Caption property value). Inherited from BarItem.
UpdateBindings(BindingContext) Updates data bindings used by this BarItem. Inherited from BarItem.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DownChanged Occurs after the item's pressed state has been changed. Inherited from BarBaseButtonItem.
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.
See Also