Skip to main content
Bar

BarHeaderItemLink Members

A link to the BarHeaderItem object.

Properties

Name Description
Accelerator Gets the hotkey combination for the current BarItemLink. Inherited from BarItemLink.
ActAsButtonGroup 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.
ActualRibbonStyle Returns the current ribbon style of this specific item link. Inherited from BarItemLink.
Alignment 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.
AllowCollapseInSimplifiedRibbon If the RibbonControl.RibbonStyle property equals Office2019, users can switch between normal and Simplified Ribbon states. In the Simplified state, a Ribbon has only one row for all its items, and hides some of them if there is not enough free space. The AllowCollapseInSimplifiedRibbon property specifies whether a Simplified Ribbon can hide this item link, or it should be always visible. Inherited from BarItemLink.
AllowHtmlText Gets whether HTML text formatting is enabled for the corresponding BarItem object. Inherited from BarItemLink.
Bar Returns a Bar to which the current item link belongs. Inherited from BarItemLink.
BeginGroup 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.
Bounds Gets the bounds of the current link. Inherited from BarItemLink.
CanDrag Gets whether users can move this link between bars and remove it. For internal use. Inherited from BarItemLink.
CanPress Gets a value indicating whether the current item link can be pressed. Inherited from BarItemLink.
CanResize Gets or sets whether the link can be resized. Inherited from BarItemLink.
CanSelectInCustomization Indicates whether the current item link can be selected when customization is performed. Inherited from BarItemLink.
CanShowSuperTip Gets whether the bar item link’s super tip can be displayed. Inherited from BarItemLink.
CanVisible Gets a value indicating whether the link can be visible. Inherited from BarItemLink.
Caption A string containing item title. Inherited from BarStaticItemLink.
ClickCount Gets or sets the number of times the current BarItemLink has been clicked. Inherited from BarItemLink.
Data Contains data associated with the current item link. Inherited from BarItemLink.
DisplayCaption Gets the display caption of the current BarItemLink. Inherited from BarItemLink.
DisplayHint Gets a value actually displayed as a hint for the current BarItemLink. Inherited from BarItemLink.
Enabled Indicates whether the item to which the current link corresponds is enabled. Inherited from BarItemLink.
Font Gets the font to display the current item link. Inherited from BarItemLink.
GalleryBarItemName Gets the name of a RibbonGalleryBarItem object that is associated with the current link, Inherited from BarItemLink.
GalleryLinkIndex For a link representing a RibbonGalleryBarItem object within the Quick Access Toolbar, this property returns the index of the link within the Ribbon Page Group‘s link collection. Inherited from BarItemLink.
Glyph Gets the bar item link‘s image. Inherited from BarItemLink.
ImageIndex Gets or sets the index of an image used by the item link. Inherited from BarItemLink.
ImageOptions Provides access to all properties that allow you to assign and customize an icon for this BarItemLink. Inherited from BarItemLink.
ImageUri Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current link. Inherited from BarItemLink.
IsAllowHtmlText Gets whether the link’s caption can be formatted using HTML tags. Inherited from BarItemLink.
IsDefaultActAsButtonGroup Gets whether the BarItemLink.ActAsButtonGroup property is set to its default value. Inherited from BarItemLink.
IsGalleryToolbarItemLink Gets whether the link represents a gallery within the Quick Access Toolbar. Inherited from BarItemLink.
IsImageExist Indicates whether an image associated with the current item link actually exists. Inherited from BarItemLink.
IsLargeImageExist Gets whether a large image that is associated with the link’s item actually exists. Inherited from BarItemLink.
IsLinkInMenu Indicates whether the current BarItemLink is located within the opened menu. Inherited from BarItemLink.
IsMerged Gets whether this BarItemLink is merged from a child Bar. Inherited from BarItemLink.
IsPageGroupContentToolbarButtonLink Gets whether the link represents a Ribbon page group within the Quick Access Toolbar. Inherited from BarItemLink.
IsVertical Gets a value indicating whether link’s owning bar is oriented vertically. Inherited from BarItemLink.
Item Returns a BarHeaderItem to which the current item link corresponds.
ItemId Obtains the BarItem.Id property value of the item corresponding to the current link. Inherited from BarItemLink.
ItemShortcut Gets the key combination used to access this link. Inherited from BarItemLink.
KeyTip 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 Gets the bar item link‘s large image. Inherited from BarItemLink.
LinkedObject For internal use only. Inherited from BarItemLink.
Links Gets the link collection that owns the current link. Inherited from BarItemLink.
Manager Specifies the BarManager managing the current item link. Inherited from BarItemLink.
MinWidth Returns the minimum width of the current BarItemLink. Inherited from BarItemLink.
MostRecentlyUsed Determines whether the current item link is initially visible when inside a submenu. Inherited from BarItemLink.
OwnerItem Gets a link’s owner item. Inherited from BarItemLink.
OwnerListItemLink Gets or sets the BarListItemLink that owns the current item link. Inherited from BarItemLink.
OwnerPageGroup Returns the RibbonPageGroup that owns the parent BarItem of this link. Inherited from BarItemLink.
PageGroupName Gets the name of a Ribbon page group associated with the current link. Inherited from BarItemLink.
PaintStyle Gets the style to display the BarItem to which the current BarItemLink corresponds. Inherited from BarItemLink.
RecentIndex Specifies the index of the current item link among the list of the most recently used item links. Inherited from BarItemLink.
ScreenBounds Gets the bounds of the current link, its position is in screen coordinates. Inherited from BarItemLink.
ShortCutDisplayText Returns the string representation of the shortcut assigned to this link. Inherited from BarItemLink.
SvgImage Returns a vector image displayed by this BarItemLink. Inherited from BarItemLink.
UserAlignment Gets or sets the horizontal alignment of the current BarItemLink. Inherited from BarItemLink.
UserCaption Gets or sets the link’s caption defined by a user. Inherited from BarItemLink.
UserDefine Gets or sets link options that specify which link settings are determined by a user. Inherited from BarItemLink.
UserEditWidth Gets or sets the width of an editor within the current BarItemLink. Inherited from BarItemLink.
UserGlyph Gets or sets the link’s glyph defined by a user. Inherited from BarItemLink.
UserPaintStyle Gets or sets the link’s paint style defined by a user. Inherited from BarItemLink.
UserRibbonStyle Gets or sets the options that specify the current BarItemLink‘s possible states within a Ribbon Control. Inherited from BarItemLink.
UserWidth Gets or sets the link’s width defined by a user. Inherited from BarItemLink.
Visible Determines whether the current item link is visible at runtime. Inherited from BarItemLink.
Width Gets link width. Inherited from BarStaticItemLink.

Methods

Name Description
AssignKeyTip(BarItemLink) Copies the value of the BarItemLink.KeyTip property from the specified object to the current object. Inherited from BarItemLink.
BeginUpdate() Locks the BarItemLink object by preventing visual updates of the object and its elements until the EndUpdate method is called. Inherited from BarItemLink.
ContainsSubItemLink(BarItemLink) Indicates whether the BarItemLink contains a specific BarItemLink. Inherited from BarItemLink.
Dispose() Releases all resources used by the BarItemLink. Inherited from BarItemLink.
EndUpdate() Unlocks the BarItemLink object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BarItemLink.
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.
Focus() Moves focus to the link. Inherited from BarItemLink.
GetActAsButtonGroupDefault() Gets the default value for the BarItemLink.ActAsButtonGroup property. Inherited from BarItemLink.
GetBeginGroup() Returns if a bar item link starts a group. Inherited from BarItemLink.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLinkHorzIndent() Returns the size of the horizontal indent between the content and the borders of a bar link. Inherited from BarItemLink.
GetLinkHorzIndent(Single) Returns the actual horizontal indent for this link, when displayed on a screen with the given scale factor. Inherited from BarItemLink.
GetLinkVertIndent() Returns the size of the vertical indent between the content and the borders of a bar link. Inherited from BarItemLink.
GetLinkVertIndent(Single) Returns the actual vertical indent for this link when displayed on a screen with the given scale factor. Inherited from BarItemLink.
GetSuperTip() Gets a SuperToolTip object for the current BarItemLink. Inherited from BarItemLink.
GetType() Gets the Type of the current instance. Inherited from Object.
HideHint() Hides the hint. Inherited from BarItemLink.
Invalidate() Redraws the current BarItemLink. Inherited from BarItemLink.
LinkPointToScreen(Point) Converts the coordinates of a specific Point that belongs to the current link into screen coordinates. Inherited from BarItemLink.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
RectangleToScreen(Rectangle) Converts a rectangle’s coordinates, which are relative to the current link, to coordinates relative to the screen. Inherited from BarItemLink.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh() Redraws the current link. Inherited from BarItemLink.
Reset() Disables all link options defined by a user. Inherited from BarItemLink.
ResetUserCaption() Resets the caption of this Bar Item Link to the caption of its parent Bar Item. Inherited from BarItemLink.
ScreenToLinkPoint(Point) Converts the coordinates of a specific screen Point into the coordinates of the current item link. Inherited from BarItemLink.
ShowHint() Moves the mouse pointer to the current link and shows the hint for the bar item which the link corresponds to. Inherited from BarItemLink.
ToString() Returns a string that represents the current object. Inherited from Object.
See Also