BarItem.Caption Property

A string containing the item’s caption.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

[DXCategory("Appearance")]
public virtual string Caption { get; set; }

VB.NET

<DXCategory("Appearance")>
Public Overridable Property Caption As String

Property Value

Type	Description
String	A string that specifies the item’s caption.

Remarks

Bar items can be displayed within Bars, RibbonControls and popup menus.

A caption represents an item within a bar if the BarItem.PaintStyle property value of that item is set to the BarItemPaintStyle.Caption, BarItemPaintStyle.CaptionInMenu or BarItemPaintStyle.CaptionGlyph value or that item has no associated icon. The item’s caption can be used to assign a hot key for the current item. This hotkey is one of the caption symbols pressed together with the Alt key. The caption letter used in a hot key combination is defined by entering an ampersand before the required symbol. The appropriate symbol is underlined in the caption.

A RichEditControl allows you to create a Bars or Ribbon UI, where bars and Ribbon controls contain a set of predefined RichEditControl-aware commands (bar items). These items have predefined captions, which you can change according to your needs. Setting the Caption properties for these items to empty strings will result in reverting the captions to their initial values.

You have the ability to format the Caption using HTML tags. To enable this feature for all bar items within a BarManager or RibbonControl, use the BarManager.AllowHtmlText and RibbonControl.AllowHtmlText property, respectively. To enable this feature for individual bar items, use the BarItem.AllowHtmlText property.

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#

office-insipred-application-rolodex-e20070/CS/Main.cs#L54

if (row != null) {
    siStatus.Caption = (String)row["Email"];
} else {

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

    OnSwitchStyle_Click(sender, e);
    if(LookAndFeel != null) LookAndFeel.LookAndFeel.SetSkinStyle(e.Item.Caption);
}

how-to-create-a-custom-bar-with-to-block-dragging-of-its-items-to-another-bar-e2457/CS/BarsCustomization/Form1.cs#L24

item = new BarCheckItem();
item.Caption = "barCheckItem";
bar.AddItem(item);

how-to-merge-usercontrols-toolbars-with-the-main-forms-toolbars-e753/CS/UserControl1.cs#L147

private void barButtonItem1_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    MessageBox.Show(e.Item.Caption);
}

how-to-share-a-single-barmanager-between-different-usercontrols-e1927/CS/B143239/PropertiesUserControl.cs#L28

categoriesItem = new BarCheckItem(manager, true);
categoriesItem.Caption = "By category";
categoriesItem.CheckedChanged += new ItemClickEventHandler(OnBarCheckItemCheckedChanged);

VB.NET

how-to-emulate-the-ms-word-information-status-bar-when-using-richeditcontrol-t467150/VB/WindowsFormsApplication1/Form1.vb#L46

Dim currentPageIndex As Integer = richEdit.Views.PrintLayoutView.CurrentPageIndex
barStaticItem3.Caption = String.Format("Current page: {0}", currentPageIndex + 1)

office-insipred-application-rolodex-e20070/VB/Main.vb#L54

If row IsNot Nothing Then
    siStatus.Caption = CType(row("Email"), String)
Else

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

If LookAndFeel IsNot Nothing Then
    LookAndFeel.LookAndFeel.SetSkinStyle(e.Item.Caption)
End If

how-to-create-a-custom-bar-with-to-block-dragging-of-its-items-to-another-bar-e2457/VB/BarsCustomization/Form1.vb#L22

item = New BarCheckItem()
item.Caption = "barCheckItem"
bar.AddItem(item)

how-to-fill-a-toolbar-with-items-using-data-from-a-table-e2741/VB/BarsMenuFromDataTable/Form1.vb#L33

barItem.Name = (CStr(row("Caption"))).ToLower()
barItem.Caption = CStr(row("Caption"))
barItem.Manager = barManager1