DashboardItemMouseHitTestEventArgs.GetUnderlyingData() Method

Returns underlying data corresponding to the visual element located under the test point.

Namespace: DevExpress.DashboardWin

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

Declaration

C#

public DashboardUnderlyingDataSet GetUnderlyingData()

VB.NET

Public Function GetUnderlyingData As DashboardUnderlyingDataSet

Returns

Type	Description
DashboardUnderlyingDataSet	A DashboardUnderlyingDataSet object that represents a list of records from the dashboard data source.

Remarks

Note that the GetUnderlyingData method does not return data for calculated fields containing the Aggr function.

Example

This example demonstrates how to display the underlying data when an end-user double-clicks a dashboard item.

Handle the DashboardItem.DoubleClick event. Call the e.GetUnderlyingData method to retrieve records from the dashboard item’s data source. Invoke a form with the Grid control that displays the data.

View Example

Note

Starting with v19.2, you can use the built-in Data Inspector to display the underlying data.

Form1.cs

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
using DevExpress.Utils;
using DevExpress.XtraEditors;
using System.Windows.Forms;

namespace Dashboard_UnderlyingDataWin {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
        }

        private void dashboardViewer1_DashboardItemDoubleClick(object sender, DashboardItemMouseActionEventArgs e) {
            XtraForm form = new XtraForm {
                Text = "Underlying Data"
            };
            DashboardUnderlyingDataSet underlyingData = e.GetUnderlyingData();

            if (underlyingData != null && underlyingData.RowCount > 0) {
                DevExpress.XtraGrid.GridControl grid = new DevExpress.XtraGrid.GridControl {
                    Parent = form,
                    Dock = DockStyle.Fill,
                    DataSource = underlyingData,
                };
            }
            else {
                LabelControl lbl = new LabelControl {
                    Text = "No Data",
                    Parent = form,
                };
                lbl.AutoSizeMode = LabelAutoSizeMode.None;
                lbl.Appearance.TextOptions.HAlignment = HorzAlignment.Center;
                lbl.Appearance.TextOptions.VAlignment = VertAlignment.Center;
                lbl.Dock = DockStyle.Fill;
            }

            form.ShowDialog();
            form.Dispose();
        }
    }
}

Form1.vb

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
Imports DevExpress.Utils
Imports DevExpress.XtraEditors
Imports System.Windows.Forms

Namespace Dashboard_UnderlyingDataWin
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub dashboardViewer1_DashboardItemDoubleClick(ByVal sender As Object, ByVal e As DashboardItemMouseActionEventArgs) Handles dashboardViewer1.DashboardItemDoubleClick
            Dim form As XtraForm = New XtraForm With {.Text = "Underlying Data"}
            Dim underlyingData As DashboardUnderlyingDataSet = e.GetUnderlyingData()


            If underlyingData IsNot Nothing AndAlso underlyingData.RowCount > 0 Then
                Dim grid As DevExpress.XtraGrid.GridControl = New DevExpress.XtraGrid.GridControl With {.Parent = form, .Dock = DockStyle.Fill, .DataSource = underlyingData}
            Else
                Dim lbl As LabelControl = New LabelControl With {.Text = "No Data", .Parent = form}
                lbl.AutoSizeMode = LabelAutoSizeMode.None
                lbl.Appearance.TextOptions.HAlignment = HorzAlignment.Center
                lbl.Appearance.TextOptions.VAlignment = VertAlignment.Center
                lbl.Dock = DockStyle.Fill
            End If

            form.ShowDialog()
            form.Dispose()
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

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-add-custom-interactivity-to-dashboard/CS/Dashboard_CustomVisualInteractivity/Form1.cs#L58

grid.Parent = form; grid.Dock = DockStyle.Fill;
grid.DataSource = e.GetUnderlyingData();
form.ShowDialog();

winforms-dashboard-get-underlying-data-for-clicked-item/CS/Dashboard_UnderlyingDataWin/Form1.cs#L17

};
DashboardUnderlyingDataSet underlyingData = e.GetUnderlyingData();

VB.NET

winforms-dashboard-add-custom-interactivity-to-dashboard/VB/Dashboard_CustomVisualInteractivity/Form1.vb#L54

grid.Dock = DockStyle.Fill
grid.DataSource = e.GetUnderlyingData()
form.ShowDialog()

winforms-dashboard-get-underlying-data-for-clicked-item/VB/Dashboard_UnderlyingDataWin/Form1.vb#L17

Dim form As XtraForm = New XtraForm With {.Text = "Underlying Data"}
Dim underlyingData As DashboardUnderlyingDataSet = e.GetUnderlyingData()