BarButtonItem.Caption Property

Gets or sets the BarButtonItem‘s caption.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

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-winforms-export-doc-odt/CS/WindowsFormsApplication1/Form1.cs#L40

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

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/DashboardDescriptionModule.cs#L34

BarButtonItem barItem = new BarButtonItem();
barItem.Caption = caption;
barItem.ImageOptions.SvgImage = barImage;

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

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

winforms-pdf-viewer-manage-popup-menu-items/CS/RemoveItemsFromPopupMenu/Form1.cs#L22

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

VB.NET

reporting-winforms-export-doc-odt/VB/WindowsFormsApplication1/Form1.vb#L40

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

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/DashboardDescriptionModule.vb#L34

Dim barItem As New BarButtonItem()
barItem.Caption = caption
barItem.ImageOptions.SvgImage = barImage

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

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

winforms-pdf-viewer-manage-popup-menu-items/VB/RemoveItemsFromPopupMenu/Form1.vb#L20

Dim browseBarButton As BarButtonItem = New BarButtonItem()
browseBarButton.Caption = "Custom Item"
' Insert the bar buttom item into the PDF Viewer popup menu and start a new group.