Bar

BarItemLink Members

Specifies a bar element.

Properties

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

Methods

Name Description
AssignKeyTip(BarItemLink) Copies the value of the BarItemLink.KeyTip property from the specified object to the current object.
BeginUpdate() Locks the BarItemLink object by preventing visual updates of the object and its elements until the EndUpdate method is called.
ContainsSubItemLink(BarItemLink) Indicates whether the BarItemLink contains a specific BarItemLink.
Dispose() Releases all resources used by the BarItemLink.
EndUpdate() Unlocks the BarItemLink object after a call to the BeginUpdate method and causes an immediate visual update.
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.
Focus() Moves focus to the link.
GetActAsButtonGroupDefault() Gets the default value for the BarItemLink.ActAsButtonGroup property.
GetBeginGroup() Returns if a bar item link starts a group.
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.
GetLinkHorzIndent(Single)
GetLinkVertIndent() Returns the size of the vertical indent between the content and the borders of a bar link.
GetLinkVertIndent(Single)
GetSuperTip() Gets a SuperToolTip object for the current BarItemLink.
GetType() Gets the Type of the current instance. Inherited from Object.
HideHint() Hides the hint.
Invalidate() Redraws the current BarItemLink.
LinkPointToScreen(Point) Converts the coordinates of a specific Point that belongs to the current link into screen coordinates.
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.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh() Redraws the current link.
Reset() Disables all link options defined by a user.
ScreenToLinkPoint(Point) Converts the coordinates of a specific screen Point into the coordinates of the current item link.
ShowHint() Moves the mouse pointer to the current link and shows the hint for the bar item which the link corresponds to.
ToString() Returns a string that represents the current object. Inherited from Object.
See Also