DataDashboardItem Class

Serves as the base class for data-bound dashboard items.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#
VB.NET

public abstract class DataDashboardItem :
    DashboardItem,
    ISliceDataQueryProvider,
    IDimensionAxes,
    IMasterFilter,
    IMasterFilterItem,
    IDataItemRepositoryProvider,
    IDataSourceSchemaProvider,
    IDataItemContext,
    IFormatOwnerContext,
    IDataItemContainerContext,
    IColorSchemeContext,
    IFormatRulesContext,
    IInteractivityOptionsProvider,
    IDataSourceNameProvider

Public MustInherit Class DataDashboardItem
    Inherits DashboardItem
    Implements ISliceDataQueryProvider,
               IDimensionAxes,
               IMasterFilter,
               IMasterFilterItem,
               IDataItemRepositoryProvider,
               IDataSourceSchemaProvider,
               IDataItemContext,
               IFormatOwnerContext,
               IDataItemContainerContext,
               IColorSchemeContext,
               IFormatRulesContext,
               IInteractivityOptionsProvider,
               IDataSourceNameProvider

Remarks

Data-bound dashboard items are UI elements that can be supplied with data from the Dashboard data sources (the Dashboard.DataSources collection). The DataDashboardItem class provides basic functionality for all data-bound dashboard items.

Use the Dashboard.Items property to add the DataDashboardItem to the dashboard. To bind the current dashboard item to the required data source, use the DataDashboardItem.DataSource property. If you are using the DashboardSqlDataSource or DashboardEFDataSource to supply the dashboard with data, you need to specify the required data member using the DataDashboardItem.DataMember property.

For examples on how to create a data dashboard item, see the corresponding DataDashboardItem descendant’s description.

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

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#
VB.NET

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DashboardMerger/ParametersMerger.cs#L34

parameterCopy.Name = NamesGenerator.GenerateName("RenamedParameter", 1, dashboardMerger.TargetDashboard.Parameters.Select(p => p.Name));
IEnumerable<DataDashboardItem> dataDashboardItems = dashboardMerger.TargetDashboard.Items.Where(item => item is DataDashboardItem).Cast<DataDashboardItem>();
string originalNamePattern = String.Format("?{0}", originalName);

how-to-replace-dashboardsqldatasource-with-dashboardobjectdatasource-with-filtered-data-t556759/CS/ASPxDashboard/Default.aspx.cs#L81


foreach (var item in dashboard.Items.OfType<DataDashboardItem>().Where(i => Object.ReferenceEquals(i.DataSource, query.DataSource) && i.DataMember == query.Query.Name)) {
    item.DataMember = "";

winforms-dashboard-extract-data-source/CS/ExtractDataSourceExample/Form1.cs#L28

extractDataSource.UpdateExtractFile();
foreach (DataDashboardItem item in dashboardViewer1.Dashboard.Items)
    if (item.DataSource == ds)

how-to-bind-dashboard-to-sql-server-database-file/CS/BindToMsSqlDatabaseFileExample/Form1.cs#L18

foreach (var item in dashboard.Items) {
    DataDashboardItem dataItem = item as DataDashboardItem;
    if (dataItem != null) {

win-dashboard-designer-master-drill-down/CS/WinForms_Dashboard_Drill-Down/MasterDrillDownModule.cs#L64

DashboardState state = new DashboardState();
foreach(var item in designer.Dashboard.Items.OfType<DataDashboardItem>().Where(i => !GetCustomPropertyValue(i.ComponentName, IgnoreMFDPropertyName)))
    state.Items.Add(new DashboardItemState(item.ComponentName) { DrillDownValues = drillDownValues });

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DashboardMerger/ParametersMerger.vb#L39

parameterCopy.Name = NamesGenerator.GenerateName("RenamedParameter", 1, dashboardMerger.TargetDashboard.Parameters.Select(Function(p) p.Name))
Dim dataDashboardItems As IEnumerable(Of DataDashboardItem) = dashboardMerger.TargetDashboard.Items.Where(Function(item) TypeOf item Is DataDashboardItem).Cast(Of DataDashboardItem)()
Dim originalNamePattern As String = String.Format("?{0}", originalName)

how-to-replace-dashboardsqldatasource-with-dashboardobjectdatasource-with-filtered-data-t556759/VB/ASPxDashboard/Default.aspx.vb#L83

dashboard.DataSources.Add(ods)
For Each item In dashboard.Items.OfType(Of DataDashboardItem)().Where(Function(i) Object.ReferenceEquals(i.DataSource, dsQuery.DataSource) AndAlso i.DataMember = dsQuery.Query.Name)
    item.DataMember = ""

winforms-dashboard-extract-data-source/VB/ExtractDataSourceExample/Form1.vb#L31

extractDataSource.UpdateExtractFile()
For Each item As DataDashboardItem In dashboardViewer1.Dashboard.Items
    If item.DataSource Is ds Then

how-to-bind-dashboard-to-sql-server-database-file/VB/BindToMsSqlDatabaseFileExample/Form1.vb#L20

For Each item In dashboard.Items
    Dim dataItem As DataDashboardItem = TryCast(item, DataDashboardItem)
    If dataItem IsNot Nothing Then

win-dashboard-designer-master-drill-down/VB/WinForms_Dashboard_Drill-Down/MasterDrillDownModule.vb#L66

Dim state As New DashboardState()
For Each item In designer.Dashboard.Items.OfType(Of DataDashboardItem)().Where(Function(i) Not GetCustomPropertyValue(i.ComponentName, IgnoreMFDPropertyName))
    state.Items.Add(New DashboardItemState(item.ComponentName) With {.DrillDownValues = drillDownValues})

Implements

ICustomPropertyProvider

.NET Subscription

Common Tools

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

.NET Subscription

Common Tools

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

DataDashboardItem Class

Declaration

Remarks

Implements

Inheritance

DataDashboardItem Class

Declaration

Remarks

Related GitHub Examples

Implements

Inheritance