DashboardToolbarItem.ButtonType Property

Gets the type of the clicked command button.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public DashboardButtonType ButtonType { get; }

VB.NET

Public ReadOnly Property ButtonType As DashboardButtonType

Property Value

Type	Description
DashboardButtonType	A DashboardButtonType enumeration value that is the type of the command button.

Available values:

Show 14 items

Name	Description
None	The value does not correspond to any command button.
DrillUp	Identifies the Drill Up button.
ClearMasterFilter	Identifies the Clear Master Filter button.
ClearSelection	Identifies the Clear Selection button.
Values	Identifies the Values button.
Export	Identifies the Export to button.
Parameters	Identifies the Parameters button.
MapInitialExtent	Identifies the Initial Extent button.
DateTimePeriods	Identifies the Select Date Time Period button of the Range Filter dashboard item.
MultiSelect	Identifies the Multi-Select button.
Maximize	Identifies the Maximize button.
Restore	Identifies the Restore button.
Custom	Identifies a button created in the CustomizeDashboardTitle or CustomizeDashboardItemCaption event handlers.
InspectData	Identifies the Inspect Data button.

Remarks

Use this property to determine the built-in button’s type. If a button is added in the CustomizeDashboardTitle or CustomizeDashboardItemCaption event handlers, the type is Custom.

Related GitHub Examples

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

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

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

private void RemoveExportButton(IList<DashboardToolbarItem> items) {
    var exportItem = items.FirstOrDefault(i => i.ButtonType == DashboardButtonType.Export);
    if (exportItem != null) {

VB.NET

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

Private Sub DashboardViewer1_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
    Dim exportItem = e.Items.FirstOrDefault(Function(i) i.ButtonType = DashboardButtonType.Export)
    If exportItem IsNot Nothing Then

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

Private Sub RemoveExportButton(ByVal items As IList(Of DashboardToolbarItem))
    Dim exportItem = items.FirstOrDefault(Function(i) i.ButtonType = DashboardButtonType.Export)
    If exportItem IsNot Nothing Then