DashboardToolbarItem Class

An element, contained in the dashboard title or dashboard item caption, such as a command button.

Namespace: DevExpress.DashboardWin

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

Declaration

C#

public class DashboardToolbarItem :
    IDashboardToolbarItem,
    IDisposable

VB.NET

Public Class DashboardToolbarItem
    Implements IDashboardToolbarItem,
               IDisposable

Remarks

Elements of this type are command buttons located in the dashboard title or dashboard item caption. They are contained in the e.Items collection accessible in the following event handlers:

Component	Event
DashboardViewer	CustomizeDashboardTitle, CustomizeDashboardItemCaption
DashboardDesigner	CustomizeDashboardTitle, CustomizeDashboardItemCaption

View Example: WinForms Dashboard - How to customize the dashboard title and dashboard item captions

To add a new command button to the dashboard title or dashboard item caption, handle the related event, create a new DashboardToolbarItem instance, specify its characteristics and insert it into the e.Items collection:

C#

// Add a button to navigate to the company site.
DashboardToolbarItem infoLinkItem = new DashboardToolbarItem("",
    new Action<DashboardToolbarItemClickEventArgs>((args) => {
        System.Diagnostics.Process.Start("https://www.devexpress.com/");
    }));
infoLinkItem.SvgImage = svgImageCollection1["support"];
e.Items.Insert(0,infoLinkItem);

VB.NET

' Add a button to navigate to the company site.
Dim infoLinkItem As DashboardToolbarItem = New DashboardToolbarItem("", New Action(Of DashboardToolbarItemClickEventArgs)(Sub(args)
    System.Diagnostics.Process.Start("https://www.devexpress.com/")
End Sub))
infoLinkItem.SvgImage = svgImageCollection1("support")
e.Items.Insert(0,infoLinkItem)

Related GitHub Examples

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

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-how-to-customize-the-dashboard-title-and-dashboard-item-captions-t630210/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L37

}
DashboardToolbarItem toolbarItem = new DashboardToolbarItem();
toolbarItem.Caption = "Filter: " + filterText;

how-to-create-a-dashboard-layout-from-scratch-e5206/CS/Dashboard_LayoutCustomization/Form1.cs#L86

{
    var exportItem = e.Items.FirstOrDefault(i => i.ButtonType == DashboardButtonType.Export);
    if (exportItem != null)

winforms-dashboard-viewer-tab-navigation-buttons-tab-animation/CS/DashboardNextPrevTab/ViewerForm.cs#L32

void DashboardViewerCustomizeDashboardTitle(object sender, CustomizeDashboardTitleEventArgs e) {
    DashboardToolbarItem nextTabItem = new DashboardToolbarItem("Next tab", NextPrevTabItemClick);
    nextTabItem.Tag = NextPrevValue.Next;

how-to-apply-conditional-formatting-to-grid-cells-in-win-dashboard/CS/Dashboard_ConditionalFormatting_Grid/IconRangeConditionForm.cs#L25

{
    DashboardToolbarItem itemUpdate = new DashboardToolbarItem((args) => UpdateFormatting()) {
        Caption = "Update Format Rule",

winforms-dashboard-extract-data-source/CS/ExtractDataSourceExample/Form1.cs#L62

private void DashboardViewer1_CustomizeDashboardTitle(object sender, CustomizeDashboardTitleEventArgs e) {
    DashboardToolbarItem itemUpdate = new DashboardToolbarItem((args) => UpdateExtract()) {
        Caption = "Update Extract Data Source",

VB.NET

winforms-dashboard-how-to-customize-the-dashboard-title-and-dashboard-item-captions-t630210/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L40

Next item
Dim toolbarItem As New DashboardToolbarItem()
toolbarItem.Caption = "Filter: " & filterText

how-to-create-a-dashboard-layout-from-scratch-e5206/VB/Dashboard_LayoutCustomization/Form1.vb#L76

End If
Dim btnChangeLayout As New DashboardToolbarItem()
btnChangeLayout.Caption = "Change Layout"

winforms-dashboard-viewer-tab-navigation-buttons-tab-animation/VB/DashboardNextPrevTab/ViewerForm.vb#L37

Private Sub DashboardViewerCustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
    Dim nextTabItem As DashboardToolbarItem = New DashboardToolbarItem("Next tab", AddressOf NextPrevTabItemClick)
    nextTabItem.Tag = NextPrevValue.Next

how-to-apply-conditional-formatting-to-grid-cells-in-win-dashboard/VB/Dashboard_ConditionalFormatting_Grid/GradientRangeConditionForm.vb#L27

Private Sub DashboardViewer1_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
    Dim itemUpdate As New DashboardToolbarItem(Sub(args) UpdateFormatting()) With {.Caption = "Update Format Rule"}
    e.Items.Add(itemUpdate)

winforms-dashboard-extract-data-source/VB/ExtractDataSourceExample/Form1.vb#L67

Private Sub DashboardViewer1_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
    Dim itemUpdate As New DashboardToolbarItem(Sub(args) UpdateExtract()) With {.Caption = "Update Extract Data Source"}
    e.Items.Add(itemUpdate)

Implements

IDashboardToolbarItem

Inheritance

Object

DashboardToolbarItem