Back to Devexpress

BarItemLink Members

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

latest18.7 KB
Original Source

BarItemLink Members

Specifies a bar element.

Properties

NameDescription
AcceleratorGets the hotkey combination for the current BarItemLink.
ActAsButtonGroupGets 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.
ActualRibbonStyleReturns the current ribbon style of this specific item link.
AlignmentGets the link’s horizontal alignment.
AllowCollapseInSimplifiedRibbonIf 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.
AllowHtmlTextGets whether HTML text formatting is enabled for the corresponding BarItem object.
BarReturns a Bar to which the current item link belongs.
BeginGroupDetermines whether the current item link starts a group.
BoundsGets the bounds of the current link.
CanDragGets whether users can move this link between bars and remove it. For internal use.
CanPressGets a value indicating whether the current item link can be pressed.
CanResizeGets or sets whether the link can be resized.
CanSelectInCustomizationIndicates whether the current item link can be selected when customization is performed.
CanShowSuperTipGets whether the bar item link’s super tip can be displayed.
CanVisibleGets a value indicating whether the link can be visible.
CaptionA string containing the item’s caption.
ClickCountGets or sets the number of times the current BarItemLink has been clicked.
DataContains data associated with the current item link.
DisplayCaptionGets the display caption of the current BarItemLink.
DisplayHintGets a value actually displayed as a hint for the current BarItemLink.
EnabledIndicates whether the item to which the current link corresponds is enabled.
FontGets the font to display the current item link.
GalleryBarItemNameGets the name of a RibbonGalleryBarItem object that is associated with the current link,
GalleryLinkIndexFor 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.
GlyphGets the bar item link‘s image.
ImageIndexGets or sets the index of an image used by the item link.
ImageOptionsProvides access to all properties that allow you to assign and customize an icon for this BarItemLink.
ImageUriGets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current link.
IsAllowHtmlTextGets whether the link’s caption can be formatted using HTML tags.
IsDefaultActAsButtonGroupGets whether the BarItemLink.ActAsButtonGroup property is set to its default value.
IsGalleryToolbarItemLinkGets whether the link represents a gallery within the Quick Access Toolbar.
IsImageExistIndicates whether an image associated with the current item link actually exists.
IsLargeImageExistGets whether a large image that is associated with the link’s item actually exists.
IsLinkInMenuIndicates whether the current BarItemLink is located within the opened menu.
IsMergedGets whether this BarItemLink is merged from a child Bar.
IsPageGroupContentToolbarButtonLinkGets whether the link represents a Ribbon page group within the Quick Access Toolbar.
IsVerticalGets a value indicating whether link’s owning bar is oriented vertically.
ItemReturns a BarItem to which the current item link corresponds.
ItemIdObtains the BarItem.Id property value of the item corresponding to the current link.
ItemShortcutGets the key combination used to access this link.
KeyTipGets or sets the Key Tip for a bar item link.
LargeGlyphGets the bar item link‘s large image.
LinkedObjectFor internal use only.
LinksGets the link collection that owns the current link.
ManagerSpecifies the BarManager managing the current item link.
MinWidthReturns the minimum width of the current BarItemLink.
MostRecentlyUsedDetermines whether the current item link is initially visible when inside a submenu.
OwnerItemGets a link’s owner item.
OwnerListItemLinkGets or sets the BarListItemLink that owns the current item link.
OwnerPageGroupReturns the RibbonPageGroup that owns the parent BarItem of this link.
PageGroupNameGets the name of a Ribbon page group associated with the current link.
PaintStyleGets the style to display the BarItem to which the current BarItemLink corresponds.
RecentIndexSpecifies the index of the current item link among the list of the most recently used item links.
ScreenBoundsGets the bounds of the current link, its position is in screen coordinates.
ShortCutDisplayTextReturns the string representation of the shortcut assigned to this link.
SvgImageReturns a vector image displayed by this BarItemLink.
UserAlignmentGets or sets the horizontal alignment of the current BarItemLink.
UserCaptionGets or sets the link’s caption defined by a user.
UserDefineGets or sets link options that specify which link settings are determined by a user.
UserEditWidthGets or sets the width of an editor within the current BarItemLink.
UserGlyphGets or sets the link’s glyph defined by a user.
UserPaintStyleGets or sets the link’s paint style defined by a user.
UserRibbonStyleGets or sets the options that specify the current BarItemLink‘s possible states within a Ribbon Control.
UserWidthGets or sets the link’s width defined by a user.
VisibleDetermines whether the current item link is visible at runtime.
WidthSpecifies the current item link’s width.

Methods

NameDescription
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, 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.
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)Returns the actual horizontal indent for this link, when displayed on a screen with the given scale factor.
GetLinkVertIndent()Returns the size of the vertical indent between the content and the borders of a bar link.
GetLinkVertIndent(Single)Returns the actual vertical indent for this link when displayed on a screen with the given scale factor.
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() protectedCreates 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) staticDetermines 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.
ResetUserCaption()Resets the caption of this Bar Item Link to the caption of its parent Bar Item.
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

BarItemLink Class

DevExpress.XtraBars Namespace