DashboardToolbarItemClickEventArgs Class

Provides data for the action performed after clicking the command button in the dashboard title or dashboard item caption.

Namespace: DevExpress.DashboardWin

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

Declaration

C#

public class DashboardToolbarItemClickEventArgs :
    EventArgs

VB.NET

Public Class DashboardToolbarItemClickEventArgs
    Inherits EventArgs

Remarks

An instance of this class is accessible in a click action assigned to a DashboardToolbarItem created in the CustomizeDashboardTitle or CustomizeDashboardItemCaption event handlers of the DashboardViewer or DashboardDesigner classes.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardToolbarItemClickEventArgs 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#

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

private void ChangeLayout(DashboardToolbarItemClickEventArgs args)
{

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

}
void NextPrevTabItemClick(DashboardToolbarItemClickEventArgs args) {
    ShowNextPrevTab((NextPrevValue)args.Item.Tag);

winforms-dashboard-how-to-customize-the-dashboard-title-and-dashboard-item-captions-t630210/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L53

DashboardToolbarMenuItem menuItem = new DashboardToolbarMenuItem(item.ShowCaption, item.Name,
    new Action<DashboardToolbarItemClickEventArgs>((args) => {
        item.ShowCaption = !item.ShowCaption;

winforms-dashboard-item-collection-changed-event/CS/Dashboard_ItemCollectionChanged_Example/Form1.cs#L52

{
    e.Items.Add(new DashboardToolbarItem("Clear Log", new Action<DashboardToolbarItemClickEventArgs>((args) =>
    {

winforms-dashboard-how-to-delay-data-load-until-all-filters-are-set-t629796/CS/CustomShowDataExample/DesignerForm1.cs#L24

DashboardToolbarItem showDataItem = new DashboardToolbarItem(showData, "Select states in the State list box and click this button to display data",
    new Action<DashboardToolbarItemClickEventArgs>((args) => {
        showDataParameter.Value = !showData;

VB.NET

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

Private Sub ChangeLayout(ByVal args As DashboardToolbarItemClickEventArgs)
    Dim dashboard As New Dashboard()

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

Private Sub NextPrevTabItemClick(ByVal args As DashboardToolbarItemClickEventArgs)
    ShowNextPrevTab(CType(args.Item.Tag, NextPrevValue))

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

For Each item In viewer.Dashboard.Items
    Dim menuItem As DashboardToolbarMenuItem = New DashboardToolbarMenuItem(item.ShowCaption, item.Name, New Action(Of DashboardToolbarItemClickEventArgs)(Sub(args)
        item.ShowCaption = Not item.ShowCaption

winforms-dashboard-item-collection-changed-event/VB/Dashboard_ItemCollectionChanged_Example/Form1.vb#L47

Private Sub DashboardDesigner1_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
    e.Items.Add(New DashboardToolbarItem("Clear Log", New Action(Of DashboardToolbarItemClickEventArgs)(Sub(args)
        memoEdit1.Text = String.Empty

winforms-dashboard-how-to-delay-data-load-until-all-filters-are-set-t629796/VB/CustomShowDataExample/DesignerForm1.vb#L20

Dim showData As Boolean = DirectCast(showDataParameter.Value, Boolean)
Dim showDataItem As DashboardToolbarItem = New DashboardToolbarItem(showData, "Select states in the State list box and click this button to display data", New Action(Of DashboardToolbarItemClickEventArgs)(Sub(args)
    showDataParameter.Value = Not showData

Inheritance

Object

EventArgs

DashboardToolbarItemClickEventArgs