DrillActionEventArgs Class

Provides data for the DrillDownPerformed and DrillUpPerformed events of the DashboardDesigner and DashboardViewer.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.2.Core.dll

Declaration

C#

public class DrillActionEventArgs :
    EventArgs

VB.NET

Public Class DrillActionEventArgs
    Inherits EventArgs

Related API Members

DrillActionEventArgs is the data class for the following events:

• DashboardControl.DrillDownPerformed
• DashboardControl.DrillUpPerformed
• DashboardDesigner.DrillDownPerformed
• DashboardDesigner.DrillUpPerformed
• DashboardViewer.DrillDownPerformed
• DashboardViewer.DrillUpPerformed
• IDashboardControl.DrillDownPerformed
• IDashboardControl.DrillUpPerformed

Remarks

The DrillDownPerformed event is raised when end-users drill down into the specified dashboard item’s element. When an end-user returns to the previous detail level (drill up), the DrillUpPerformed event is raised.

The DrillActionEventArgs class exposes the DrillActionEventArgs.DashboardItemName property that allows you to determine the name of the dashboard item in which drill-down (or drill-up) has been performed.

Use the DrillActionEventArgs.DrillDownLevel and DrillActionEventArgs.Values properties to obtain the current drill-down level and corresponding values from the drill-down hierarchy, respectively.

Note

The DrillActionEventArgs.Values property returns the DashboardSpecialValues.NullValue or DashboardSpecialValues.OthersValue values instead of null or “Others” values, respectively.

Example

The following code snippets show how to perform a drill-down in DashboardViewer.

In this example, the DashboardViewer.PerformDrillDown method performs a drill-down for a specified row in a Grid dashboard item. The combo box’s SelectedIndexChanged event handler calls the method.

Click the button to call the DashboardViewer.PerformDrillUp method to return to the top detail level.

Form1.vb

Imports System
Imports System.Collections.Generic
Imports DevExpress.XtraEditors
Imports System.Collections
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardCommon.ViewerData

Namespace Dashboard_PerformDrillDown
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            AddHandler comboBox1.SelectedIndexChanged, AddressOf comboBox1_SelectedIndexChanged
            AddHandler btnDrillUp.Click, AddressOf btnDrillUp_Click
            ' Loads a dashboard from an XML file.
            dashboardViewer1.LoadDashboard("..\..\Data\Dashboard.xml")
            ' Obtains values that can be used to perform drill-down.
            Dim drillDownValues = dashboardViewer1.GetAvailableDrillDownValues("gridDashboardItem1")
            For Each rows As AxisPointTuple In drillDownValues
                comboBox1.Items.Add(rows.GetAxisPoint().Value)
            Next rows
        End Sub

        Private Sub comboBox1_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
            Dim comboBox1 As System.Windows.Forms.ComboBox = DirectCast(sender, System.Windows.Forms.ComboBox)
            If dashboardViewer1.CanPerformDrillDown("gridDashboardItem1") = True Then
                ' Performs drill-down for a selected category.
                dashboardViewer1.PerformDrillDown("gridDashboardItem1", comboBox1.SelectedItem)
            Else
                ' Returns to the previous detail level and  
                ' performs drill-down for the selected category.
                dashboardViewer1.PerformDrillUp("gridDashboardItem1")
                dashboardViewer1.PerformDrillDown("gridDashboardItem1", comboBox1.SelectedItem)
            End If
        End Sub

        Private Sub btnDrillUp_Click(ByVal sender As Object, ByVal e As EventArgs)
            If dashboardViewer1.CanPerformDrillUp("gridDashboardItem1") = True Then
                ' Performs a drill-up in the grid dashboard item.
                dashboardViewer1.PerformDrillUp("gridDashboardItem1")
            Else
                XtraMessageBox.Show("Drill-up is not possible at the current detail level")
            End If
        End Sub
    End Class
End Namespace

Form1.cs

using System;
using System.Collections.Generic;
using DevExpress.XtraEditors;
using System.Collections;
using DevExpress.DashboardCommon;
using DevExpress.DashboardCommon.ViewerData;

namespace Dashboard_PerformDrillDown {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
            comboBox1.SelectedIndexChanged += comboBox1_SelectedIndexChanged;
            btnDrillUp.Click += btnDrillUp_Click;
            // Loads a dashboard from an XML file.
            dashboardViewer1.LoadDashboard(@"..\..\Data\Dashboard.xml");
            // Obtains values that can be used to perform drill-down.
            var drillDownValues = dashboardViewer1.GetAvailableDrillDownValues("gridDashboardItem1");
            foreach (AxisPointTuple rows in drillDownValues) {
                comboBox1.Items.Add(rows.GetAxisPoint().Value);
            }
        }

        private void comboBox1_SelectedIndexChanged(object sender, EventArgs e) {
            System.Windows.Forms.ComboBox comboBox1 = (System.Windows.Forms.ComboBox) sender;
            if (dashboardViewer1.CanPerformDrillDown("gridDashboardItem1") == true) {
                // Performs drill-down for a selected category.
                dashboardViewer1.PerformDrillDown("gridDashboardItem1", comboBox1.SelectedItem);
            }
            else {
                // Returns to the previous detail level and  
                // performs drill-down for the selected category.
                dashboardViewer1.PerformDrillUp("gridDashboardItem1");
                dashboardViewer1.PerformDrillDown("gridDashboardItem1", comboBox1.SelectedItem);
            }
        }

        private void btnDrillUp_Click(object sender, EventArgs e) {
            if (dashboardViewer1.CanPerformDrillUp("gridDashboardItem1") == true) {
                // Performs a drill-up in the grid dashboard item.
                dashboardViewer1.PerformDrillUp("gridDashboardItem1");
            }
            else XtraMessageBox.Show("Drill-up is not possible at the current detail level");
        }
    }
}

Inheritance

Object

EventArgs

DrillActionEventArgs