DashboardUnderlyingDataSet Class

Represents a list of records from the dashboard data source.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class DashboardUnderlyingDataSet :
    DashboardDataSet<DashboardUnderlyingDataRow>

VB.NET

Public Class DashboardUnderlyingDataSet
    Inherits DashboardDataSet(Of DashboardUnderlyingDataRow)

Related API Members

The following members return DashboardUnderlyingDataSet objects:

Show 34 links

• DashboardControl.GetUnderlyingData(String, IList<AxisPoint>, IList<String>)
• DashboardControl.GetUnderlyingData(String, IList<AxisPoint>)
• DashboardControl.GetUnderlyingData(String, IList<String>)
• DashboardControl.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>)
• DashboardControl.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>)
• DashboardControl.GetUnderlyingData(String)
• DashboardDesigner.GetUnderlyingData(String, IList<AxisPoint>, IList<String>)
• DashboardDesigner.GetUnderlyingData(String, IList<AxisPoint>)
• DashboardDesigner.GetUnderlyingData(String, IList<String>)
• DashboardDesigner.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>)
• DashboardDesigner.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>)
• DashboardDesigner.GetUnderlyingData(String)
• DashboardItemMouseActionWpfEventArgs.GetUnderlyingData()
• DashboardItemMouseActionWpfEventArgs.GetUnderlyingData(IList<String>)
• DashboardItemMouseActionWpfEventArgs.GetUnderlyingData(String, IList<String>)
• DashboardItemMouseActionWpfEventArgs.GetUnderlyingData(String)
• DashboardItemMouseHitTestEventArgs.GetUnderlyingData()
• DashboardItemMouseHitTestEventArgs.GetUnderlyingData(IList<String>)
• DashboardItemMouseHitTestEventArgs.GetUnderlyingData(String, IList<String>)
• DashboardItemMouseHitTestEventArgs.GetUnderlyingData(String)
• DashboardUnderlyingDataRow.DataSet
• DashboardViewer.GetUnderlyingData(String, IList<AxisPoint>, IList<String>)
• DashboardViewer.GetUnderlyingData(String, IList<AxisPoint>)
• DashboardViewer.GetUnderlyingData(String, IList<String>)
• DashboardViewer.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>)
• DashboardViewer.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>)
• DashboardViewer.GetUnderlyingData(String)
• IDashboardControl.GetUnderlyingData(String, IList<AxisPoint>, IList<String>)
• IDashboardControl.GetUnderlyingData(String, IList<AxisPoint>)
• IDashboardControl.GetUnderlyingData(String, IList<String>)
• IDashboardControl.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>)
• IDashboardControl.GetUnderlyingData(String, IList<UnderlyingDataTargetValue>)
• IDashboardControl.GetUnderlyingData(String)
• IMouseApiProvider.GetUnderlyingData(IList<AxisPoint>, IList<String>)

Remarks

A DashboardUnderlyingDataSet object is returned by the DashboardDesigner.GetUnderlyingData and DashboardViewer.GetUnderlyingData methods. Any of these methods allow you to obtain a list of records from the dashboard data source.

You can also obtain the underlying data for specific visual elements when handling DashboardViewer events, for instance, the DashboardViewer.DashboardItemClick event. Use the DashboardItemMouseHitTestEventArgs.GetUnderlyingData method to do this.

Individual rows in the DashboardUnderlyingDataSet are represented by DashboardUnderlyingDataRow objects.

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

Inheritance

Object

DevExpress.DashboardCommon.Native.DashboardDataSet<DashboardUnderlyingDataRow>

DashboardUnderlyingDataSet