DashboardToolbarItem.ClickAction Property

Gets or sets an action performed after a user clicks the dashboard toolbar item (the command button).

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v23.2.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public Action<DashboardToolbarItemClickEventArgs> ClickAction { get; set; }

VB.NET

Public Property ClickAction As Action(Of DashboardToolbarItemClickEventArgs)

Property Value

Type	Description
Action<DashboardToolbarItemClickEventArgs>	An Action delegate method that specifies an action performed after clicking the command button.

Remarks

The following code snippet calls the UpdateFormatting() method when a user clicks the custom Update Format Rule toolbar item in a dashboard title. The Action method is passed in the constructor.

View Example

C#

private void DashboardViewer1_CustomizeDashboardTitle(object sender, CustomizeDashboardTitleEventArgs e)
{
    DashboardToolbarItem itemUpdate = new DashboardToolbarItem((args) => UpdateFormatting()) {
        Caption = "Update Format Rule", 
    };
    e.Items.Add(itemUpdate);
}

VB.NET

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)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ClickAction 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#L91

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

VB.NET

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

btnChangeLayout.Caption = "Change Layout"
btnChangeLayout.ClickAction = New Action(Of DashboardToolbarItemClickEventArgs)(AddressOf ChangeLayout)
e.Items.Add(btnChangeLayout)