BarItemLink.Caption Property

A string containing the item’s caption.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

public virtual string Caption { get; set; }

VB.NET

Public Overridable Property Caption As String

Property Value

Type	Description
String	The item’s caption.

Remarks

Caption represents an item within a bar if the BarItemLink.PaintStyle property of that item is set to BarItemPaintStyle.Caption or BarItemPaintStyle.CaptionGlyph or the item has no associated icon. This property value may differ from the BarItem.Caption property. The item caption can be used to assign a hot key to the current item. This hotkey is one of the caption’s symbols used to activate a specific item. The caption symbol used for a hot key combination is defined by entering an ampersand before the required symbol. The appropriate symbol is underlined within the caption. For more information on hotkey combinations explore the BarItemLink.Accelerator topic in this manual.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-a-component-which-automatically-create-a-menu-for-all-registered-skins-e2058/CS/WindowsApplication1/MySkinsBarMenuHelper.cs#L68

{
    if (item.Caption.IndexOf("Office") > -1)
        MIOfficeSkin.AddItem(item.Item);

how-to-enumerate-buttons-in-a-menu-or-on-a-toolbar-e599/CS/Form1.cs#L928

foreach(BarItemLink link in links) {
    TreeListNode node = parent.TreeList.AppendNode(new object[] {link.Caption}, parent);
    if(link.Item is BarSubItem)

how-to-handle-the-radialmenus-mousehover-event-t191124/CS/Custom Radial Menu/MyRadialMenuWindow.cs#L25

case RadialMenuHitTest.Link:
    ShowHint(hitInfo.LinkInfo.Link.Caption);
    break;

VB.NET

how-to-create-a-component-which-automatically-create-a-menu-for-all-registered-skins-e2058/VB/WindowsApplication1/MySkinsBarMenuHelper.vb#L72

For Each item As BarItemLink In subItem.ItemLinks
    If item.Caption.IndexOf("Office") > -1 Then
        MIOfficeSkin.AddItem(item.Item)

how-to-enumerate-buttons-in-a-menu-or-on-a-toolbar-e599/VB/Form1.vb#L804

For Each link As BarItemLink In links
    Dim node As TreeListNode = parent.TreeList.AppendNode(New Object() {link.Caption}, parent)
    If TypeOf link.Item Is BarSubItem Then

how-to-handle-the-radialmenus-mousehover-event-t191124/VB/Custom Radial Menu/MyRadialMenuWindow.vb#L25

Case RadialMenuHitTest.Link
    ShowHint(hitInfo.LinkInfo.Link.Caption)
Case RadialMenuHitTest.LinkArrow