DashboardToolbarItem.Caption Property

Gets or sets the text displayed within the item.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.1.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public string Caption { get; set; }

VB.NET

Public Property Caption As String

Property Value

Type	Description
String	A String that is the text displayed witin the item.

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#

winforms-dashboard-create-layout-from-scratch/CS/Dashboard_LayoutCustomization/Form1.cs#L90

DashboardToolbarItem btnChangeLayout = new DashboardToolbarItem();
btnChangeLayout.Caption = "Change Layout";
btnChangeLayout.ClickAction = new Action<DashboardToolbarItemClickEventArgs>(ChangeLayout);

winforms-dashboard-customize-title-and-item-captions/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L38

DashboardToolbarItem toolbarItem = new DashboardToolbarItem();
toolbarItem.Caption = "Filter: " + filterText;
e.Items.Insert(0, toolbarItem);

winforms-dashboard-designer-bind-a-dashboard-to-a-list-object/CS/Dashboard_BindingToList/Form1.cs#L51

    }));
titleButton.Caption = "Reload Data";
e.Items.Add(titleButton);

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DesignerForm.cs#L65

mergeItem.SvgImage = (SvgImage)Properties.Resources.MergeIcon;
mergeItem.Caption = "Merge Dashboard";
e.Items.Insert(0, mergeItem);

winforms-dashboard-apply-master-filter-in-viewer/CS/Dashboard_SetMasterFilter/Form1.cs#L64

    new Action<DashboardToolbarItemClickEventArgs>((args) => { SetMasterFilterMethod(); }));
setMasterFilterItem.Caption = "Set Master Filter";
e.Items.Insert(0, setMasterFilterItem);

VB.NET

winforms-dashboard-create-layout-from-scratch/VB/Dashboard_LayoutCustomization/Form1.vb#L77

Dim btnChangeLayout As New DashboardToolbarItem()
btnChangeLayout.Caption = "Change Layout"
btnChangeLayout.ClickAction = New Action(Of DashboardToolbarItemClickEventArgs)(AddressOf ChangeLayout)

winforms-dashboard-customize-title-and-item-captions/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L41

Dim toolbarItem As New DashboardToolbarItem()
toolbarItem.Caption = "Filter: " & filterText
e.Items.Insert(0, toolbarItem)

winforms-dashboard-designer-bind-a-dashboard-to-a-list-object/VB/Dashboard_BindingToList/Form1.vb#L52

End Sub))
titleButton.Caption = "Reload Data"
e.Items.Add(titleButton)

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DesignerForm.vb#L69

mergeItem.SvgImage = CType(My.Resources.MergeIcon, SvgImage)
mergeItem.Caption = "Merge Dashboard"
e.Items.Insert(0, mergeItem)

winforms-dashboard-apply-master-filter-in-viewer/VB/Dashboard_SetMasterFilter/Form1.vb#L56

Dim setMasterFilterItem As DashboardToolbarItem = New DashboardToolbarItem("Set Master Filter", New Action(Of DashboardToolbarItemClickEventArgs)(Sub(args) SetMasterFilterMethod()))
setMasterFilterItem.Caption = "Set Master Filter"
e.Items.Insert(0, setMasterFilterItem)

Implements

Caption