Back to Devexpress

BarHeaderItem Members

windowsforms-devexpress-dot-xtrabars-dot-barheaderitem-dot-underscore-members.md

latest32.1 KB
Original Source

BarHeaderItem Members

Displays static text using a heading style which is determined by the current skin. The text is typically painted bold against a background that is different from the background of regular buttons. Use BarHeaderItem to add headers to a PopupMenu or BarSubItem (sub-menu) to separate sets of items.

Constructors

NameDescription
BarHeaderItem()Initializes a new instance of the BarHeaderItem class.

Properties

NameDescription
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from BarItem.
AccessibleNameGets or sets the object’s name used by accessibility client applications. Inherited from BarItem.
AccessibleRoleGets or sets the object’s accessible role. Inherited from BarItem.
AlignmentThis member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class.
AllowFocusGets or sets whether users can press the Tab Key to select (focus) this Bar Static Item. Inherited from BarStaticItem.
AllowGlyphSkinningThis member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class.
AllowHtmlTextGets or sets whether the BarItem.Caption and BarItem.Description can be formatted using HTML tags. Inherited from BarItem.
AllowRightClickInMenuGets 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.
AllowStubGlyphGets 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.
AppearanceProvides access to the appearance settings for the current header.
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. | | AutoSize | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | BindingContext | Gets or sets a BindingContext object that manages data bindings for this BarItem. Inherited from BarItem. | | Border | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | BorderStyle | Obsolete. This member is not supported. Inherited from BarItem. | | CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. | | Caption | The bar 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 | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | 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. | | 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. 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 | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | 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 | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | GlyphDisabled | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | Hint | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | Id | Uniquely identifies the current BarItem. Inherited from BarItem. | | ImageIndex | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | ImageIndexDisabled | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | 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. | | ImageToTextAlignment | Specifies whether the bar item image should go before or after this item caption. Inherited from BarStaticItem. | | ImageUri | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | 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 | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | 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 | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | ItemShortcut | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | LargeGlyph | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | LargeGlyphDisabled | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | LargeImageIndex | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | LargeImageIndexDisabled | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | LargeImages | Gets the source of large images. Inherited from BarItem. | | LargeWidth | This member is not supported by the BarStaticItem object. Inherited from BarStaticItem. | | LeftIndent | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | Links | Gets the collection of links to the bar item. Inherited from BarItem. | | Manager | Specifies the BarManager responsible for managing the current item. Inherited from BarItem. | | MaxWidth | Gets or sets the item’s maximum width in auto-size mode. Not in effect in a ribbon. Inherited from BarStaticItem. | | 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. | | MinWidth | Gets or sets the item’s minimum width in auto-size mode. Not in effect in a ribbon. Inherited from BarStaticItem. | | MultiColumn | Gets or sets whether to arrange items displayed below the BarHeaderItem in columns. | | Name | Gets or sets the BarItem‘s name. Inherited from BarItem. | | OptionsMultiColumn | Provides access to the settings of the multicolumn mode of displaying items below the current header. | | OwnFont | Obsolete. Specifies the font used to display the captions of links corresponding to this item. Inherited from BarItem. | | PaintStyle | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | RibbonStyle | Gets or sets the options that specify the bar item’s possible states within a Ribbon Control. Inherited from BarItem. | | RightIndent | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | 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 | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | ShowImageInToolbar | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | ShowInCustomizationForm | Use the BarItem.Visibility property to control bar item visibility 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. | | ShowToolTip | Gets or sets whether this item should display its hint when hovered. Inherited from BarItem. | | Site | Gets or sets the ISite of the Component. Inherited from Component. | | Size | Gets or sets the BarHeaderItem‘s size. | | SmallWithoutTextWidth | This member is not supported by the BarStaticItem object. Inherited from BarStaticItem. | | SmallWithTextWidth | This member is not supported by the BarStaticItem object. Inherited from BarStaticItem. | | SuperTip | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | Tag | Gets or sets an object that contains data on the current item. Inherited from BarItem. | | TextAlignment | This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. | | 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 | Gets or sets the fixed width for this BarStaticItem. Inherited from BarStaticItem. |

Methods

NameDescription
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.
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, Object) staticDetermines 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. 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) protectedReturns 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates 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) staticDetermines 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.
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

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
HyperlinkClickOccurs each time an end-user clicks a hyperlink within the current BarItem. Inherited from BarItem.
ItemClickOccurs when the current item is clicked. Inherited from BarItem.
ItemDoubleClickFires when a link to an item is double-clicked. Inherited from BarItem.
ItemPressFires immediately after a link associated with an item has been pressed. Inherited from BarItem.
ItemRightClickOccurs when a user right-clicks the BarItem. Inherited from BarItem.

See Also

BarHeaderItem Class

DevExpress.XtraBars Namespace