BarButtonItem.Caption Property

Gets or sets the BarButtonItem‘s caption.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

public override string Caption { get; set; }

VB.NET

Public Overrides Property Caption As String

Property Value

Type	Description
String	A String value that is the BarButtonItem‘s caption.

Remarks

You can format BarButtonItem’s Caption and BarButtonItem.Description via HTML tags if the BarItem.AllowHtmlText property equals true.

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#

Reporting_how-to-export-an-xtrareport-document-to-doc-docx-and-odt-file-formats-e4530/CS/WindowsFormsApplication1/Form1.cs#L40

barItem.ItemClick += new ItemClickEventHandler(barItem_ItemClick);
barItem.Caption = "DOC File";
control.AddItem(barItem);

Reporting_how-to-add-a-custom-item-to-the-export-menu-in-the-print-preview-window-e4515/CS/CustomItem/Form1.cs#L39

barItem.ItemClick += barItem_ItemClick;
barItem.Caption = "Custom Item";
control.AddItem(barItem);

how-to-add-a-custom-bar-button-item-to-the-popup-menu-t328781/CS/CustomPopupMenu/Form1.cs#L15

BarButtonItem browseBarButton = new BarButtonItem();
browseBarButton.Caption = "Custom Item";

winforms-assign-popupmenu-to-dropdownbutton/CS/DropDownButtonExample/Form1.cs#L28

DevExpress.XtraBars.BarButtonItem item = new BarButtonItem();
item.Caption = caption;
item.Id = this.barManager1.GetNewItemId();

VB.NET

Reporting_how-to-export-an-xtrareport-document-to-doc-docx-and-odt-file-formats-e4530/VB/WindowsFormsApplication1/Form1.vb#L40

AddHandler barItem.ItemClick, AddressOf barItem_ItemClick
barItem.Caption = "DOC File"
control.AddItem(barItem)

Reporting_how-to-add-a-custom-item-to-the-export-menu-in-the-print-preview-window-e4515/VB/CustomItem/Form1.vb#L36

AddHandler barItem.ItemClick, AddressOf barItem_ItemClick
barItem.Caption = "Custom Item"
control.AddItem(barItem)

how-to-add-a-custom-bar-button-item-to-the-popup-menu-t328781/VB/CustomPopupMenu/Form1.vb#L17

Dim browseBarButton As New BarButtonItem()
browseBarButton.Caption = "Custom Item"

winforms-assign-popupmenu-to-dropdownbutton/VB/DropDownButtonExample/Form1.vb#L29

Dim item As BarButtonItem = New BarButtonItem()
item.Caption = caption
item.Id = barManager1.GetNewItemId()