DashboardItemMouseHitTestEventArgs.GetUnderlyingData() Method

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

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v18.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

The following example demonstrates how to obtain underlying data corresponding to a particular visual element using the DashboardViewer‘s API.

In this example, the DashboardViewer.DashboardItemDoubleClick event is handled to obtain underlying data and display this data in the grid.

In the event handler, the DashboardItemMouseHitTestEventArgs.GetUnderlyingData method is called to obtain records from the dashboard’s data source.

Note

The complete sample project WinViewer - How to obtain a dashboard item’s underlying data for a clicked visual element is available in the DevExpress Examples repository.

Form1.vb

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

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 New XtraForm()
            form.Text = "Underlying Data"
            Dim underlyingData As DashboardUnderlyingDataSet = e.GetUnderlyingData()

            Dim grid As New DataGrid()
            grid.Parent = form
            grid.Dock = DockStyle.Fill
            If underlyingData IsNot Nothing Then
                grid.DataSource = underlyingData
            Else
                grid.CaptionText = "The grid has no data"
            End If
            form.ShowDialog()
            form.Dispose()
        End Sub
    End Class
End Namespace

Form1.cs

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

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

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

            DataGrid grid = new DataGrid();
            grid.Parent = form; grid.Dock = DockStyle.Fill;
            if (underlyingData != null) {
                grid.DataSource = underlyingData;
            }
            else
                grid.CaptionText = "The grid has no data";
            form.ShowDialog();
            form.Dispose();
        }
    }
}

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#

how-to-edit-data-displayed-within-the-dashboard-t289951/CS/Dashboard_EditData/DashboardViewerForm.cs#L15

DashboardItemMouseActionEventArgs e) {
if (e.DashboardItemName == "gridDashboardItem1" & e.GetUnderlyingData() != null) {
    ShowUnderlyingData(e.GetUnderlyingData());

winviewer-how-to-obtain-a-dashboard-items-underlying-data-for-a-clicked-visual-element-t129135/CS/Dashboard_UnderlyingDataWin/Form1.cs#L16

form.Text = "Underlying Data";
DashboardUnderlyingDataSet underlyingData = e.GetUnderlyingData();

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();

VB.NET

how-to-edit-data-displayed-within-the-dashboard-t289951/VB/Dashboard_EditData/DashboardViewerForm.vb#L16

Private Sub dashboardViewer1_DashboardItemClick(ByVal sender As Object, ByVal e As DashboardItemMouseActionEventArgs) Handles dashboardViewer1.DashboardItemClick
    If e.DashboardItemName = "gridDashboardItem1" And e.GetUnderlyingData() IsNot Nothing Then
        ShowUnderlyingData(e.GetUnderlyingData())

winviewer-how-to-obtain-a-dashboard-items-underlying-data-for-a-clicked-visual-element-t129135/VB/Dashboard_UnderlyingDataWin/Form1.vb#L19

form.Text = "Underlying Data"
Dim underlyingData As DashboardUnderlyingDataSet = e.GetUnderlyingData()

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

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