DataLoadingEventArgs.DataId Property

Gets an object data source’s unique identifier.

Namespace: DevExpress.DashboardCommon

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

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.Win.Dashboard.Design

Declaration

C#

public string DataId { get; }

VB.NET

Public ReadOnly Property DataId As String

Property Value

Type	Description
String	An object data source’s identifier.

Remarks

Use the DataId property to identify the data source for which the 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#

DashboardDifferentUserDataMVC/CS/MVCDashboard/App_Start/DashboardConfig.cs#L36

if (e.DataId == "odsSales") {
    if (userName == "Admin") {

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

private void ASPxDashboardObjectDS_DataLoading(object sender, DataLoadingWebEventArgs e) {
    if (e.DataId == "objectDataSource") {
        e.Data = Invoices.CreateData();

winforms-dashboard-window-function-calc-field/CS/DesignerForm1.cs#L16

private void DashboardDesigner1_DataLoading(object sender, DataLoadingEventArgs e) {
    if (e.DataId == "odsSales") {
        e.Data = ProductSales.GetProductSales();

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

private static void DataLoading(object sender, DataLoadingWebEventArgs e) {
    if (e.DataId == "objectDataSource") {
        e.Data = Invoices.CreateData();

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

private static void DataLoading(object sender, DataLoadingWebEventArgs e) {
    if(e.DataId == "odsInvoices") {
        e.Data = Invoices.CreateData();

VB.NET

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

Private Sub ASPxDashboardObjectDS_DataLoading(ByVal sender As Object, ByVal e As DataLoadingWebEventArgs)
    If Equals(e.DataId, "objectDataSource") Then
        e.Data = Invoices.CreateData()

winforms-dashboard-window-function-calc-field/VB/DesignerForm1.vb#L18

Private Sub DashboardDesigner1_DataLoading(ByVal sender As Object, ByVal e As DataLoadingEventArgs) Handles dashboardDesigner.DataLoading
    If e.DataId = "odsSales" Then
        e.Data = ProductSales.GetProductSales()

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

Private Shared Sub DataLoading(ByVal sender As Object, ByVal e As DataLoadingWebEventArgs)
    If e.DataId = "objectDataSource" Then
        e.Data = Invoices.CreateData()

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

Protected Sub DataLoading(ByVal sender As Object, ByVal e As DataLoadingWebEventArgs)
    If Equals(e.DataId, "odsInvoices") Then
        e.Data = Invoices.CreateData()