DashboardObjectDataSource.DataId Property

Gets or sets the unique identifier of an Object data source.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(null)]
public string DataId { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DataId As String

Property Value

Type	Default	Description
String	null	An Object data source’s identifier.

Remarks

Use the DataId property to identify the data source for which the DataLoading event is raised.

This example shows how to bind the ASP.NET MVC Dashboard extension to the Object Data Source and use the DashboardConfigurator.DataLoading event to supply the data source with data:

DashboardConfig.cs

using System.Web.Routing;
using DevExpress.DashboardWeb;
using DevExpress.DashboardWeb.Mvc;
using DevExpress.DashboardCommon;

namespace DashboardMVC {
    public static class DashboardConfig {
        public static void RegisterService(RouteCollection routes) {
            routes.MapDashboardRoute("dashboardControl");

            DashboardFileStorage dashboardFileStorage = new DashboardFileStorage("~/App_Data/Dashboards");
            DashboardConfigurator.Default.SetDashboardStorage(dashboardFileStorage);
            DataSourceInMemoryStorage dataSourceStorage = new DataSourceInMemoryStorage();
             // Registers an Object data source.
            DashboardObjectDataSource objDataSource = new DashboardObjectDataSource("Object Data Source");
            objDataSource.DataId = "Object Data Source ID";
            dataSourceStorage.RegisterDataSource("objDataSource", objDataSource.SaveToXml());
            DashboardConfigurator.Default.SetDataSourceStorage(dataSourceStorage);
            DashboardConfigurator.Default.DataLoading += DataLoading;
        }
         private static void DataLoading(object sender, DataLoadingWebEventArgs e) {
            if(e.DataId == "Object Data Source ID") {
                e.Data = Invoices.CreateData();
            }
        }
    }
}

DashboardConfig.vb

Imports System.Web.Routing
Imports DevExpress.DashboardWeb
Imports DevExpress.DashboardWeb.Mvc
Imports DevExpress.DashboardCommon

Namespace DashboardMVC
    Public Module DashboardConfig
        Public Sub RegisterService(ByVal routes As RouteCollection)
            routes.MapDashboardRoute("dashboardControl")

            Dim dashboardFileStorage As New DashboardFileStorage("~/App_Data/Dashboards")
            DashboardConfigurator.Default.SetDashboardStorage(dashboardFileStorage)
             Dim dataSourceStorage As New DataSourceInMemoryStorage()
             ' Registers an Object data source.
            Dim objDataSource As New DashboardObjectDataSource("Object Data Source")
            objDataSource.DataId = "Object Data Source ID"
            dataSourceStorage.RegisterDataSource("objDataSource", objDataSource.SaveToXml())
            DashboardConfigurator.Default.SetDataSourceStorage(dataSourceStorage)
            AddHandler DashboardConfigurator.Default.DataLoading, AddressOf DataLoading
        End Sub
         Private Sub DataLoading(ByVal sender As Object, ByVal e As DataLoadingWebEventArgs)
            If e.DataId = "Object Data Source ID" Then
                e.Data = Invoices.CreateData()
            End If
         End Sub
    End Module
End Namespace

Related GitHub Examples

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

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#

asp-net-web-forms-dashboard-register-data-sources/CS/WebFormsDashboardDataSources/Pages/ObjectDashboard.aspx.cs#L19

DashboardObjectDataSource objDataSource = new DashboardObjectDataSource("Object Data Source");
objDataSource.DataId = "objectDataSource";
dataSourceStorage.RegisterDataSource("objDataSource", objDataSource.SaveToXml());

asp-net-mvc-dashboard-register-data-sources/CS/MvcDashboardDataSources/Configuration/ObjectDataSourceConfigurator.cs#L9

DashboardObjectDataSource objDataSource = new DashboardObjectDataSource("Object Data Source");
objDataSource.DataId = "objectDataSource";
storage.RegisterDataSource("objDataSource", objDataSource.SaveToXml());

mvc-dashboard-hide-series-legend-click/CS/MvcDashboard/App_Start/DashboardConfig.cs#L30

DashboardObjectDataSource objDataSource = new DashboardObjectDataSource("Object Data Source");
objDataSource.DataId = "odsInvoices";
dataSourceStorage.RegisterDataSource("objDataSource", objDataSource.SaveToXml());

aspnet-web-forms-dashboard-data-federation/CS/AspNetWebFormsDataFederation/Default.aspx.cs#L31

DashboardObjectDataSource objDataSource = new DashboardObjectDataSource("Object Data Source");
objDataSource.DataId = "odsInvoices";

web-forms-dashboard-replace-sql-data-source-with-object-data-source-with-filtered-data/CS/ASPxDashboard/Default.aspx.cs#L78

ods.DataId = odsId;
dashboard.DataSources.Add(ods);

VB.NET

asp-net-web-forms-dashboard-register-data-sources/VB/WebFormsDashboardDataSources/Pages/ObjectDashboard.aspx.vb#L19

Dim objDataSource As DashboardObjectDataSource = New DashboardObjectDataSource("Object Data Source")
objDataSource.DataId = "objectDataSource"
dataSourceStorage.RegisterDataSource("objDataSource", objDataSource.SaveToXml())

asp-net-mvc-dashboard-register-data-sources/VB/MvcDashboardDataSources/Configuration/ObjectDataSourceConfigurator.vb#L9

Dim objDataSource As New DashboardObjectDataSource("Object Data Source")
objDataSource.DataId = "objectDataSource"
storage.RegisterDataSource("objDataSource", objDataSource.SaveToXml())

aspnet-web-forms-dashboard-data-federation/VB/AspNetWebFormsDataFederation/Default.aspx.vb#L27

Dim objDataSource As DashboardObjectDataSource = New DashboardObjectDataSource("Object Data Source")
objDataSource.DataId = "odsInvoices"
' Configures an Excel data source.

web-forms-dashboard-replace-sql-data-source-with-object-data-source-with-filtered-data/VB/ASPxDashboard/Default.aspx.vb#L81

ods.DataId = odsId
dashboard.DataSources.Add(ods)

web-forms-dashboard-save-dashboards-title-as-file-name/VB/DXWebApplication2/Default.aspx.vb#L26

Dim objDataSource As DashboardObjectDataSource = New DashboardObjectDataSource("Object Data Source")
objDataSource.DataId = "Object Data Source Data Id"
dataSourceStorage.RegisterDataSource("objDataSource", objDataSource.SaveToXml())