DashboardItemMouseHitTestEventArgs.GetUnderlyingData(IList<String>) 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
Parameters
Name | Type | Description |
---|---|---|
dataMembers | IList<String> | A list of String values that specifies data members used to obtain underlying data. |
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.
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