DataLoadingWebEventArgs.DashboardId Property

Gets the identifier of the current dashboard.

Namespace: DevExpress.DashboardWeb

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

Declaration

C#

public string DashboardId { get; }

VB.NET

Public ReadOnly Property DashboardId As String

Property Value

Type	Description
String	A String that identifies the current dashboard.

Remarks

If the dashboard has been loaded from the location specified by the ASPxDashboard.DashboardType property, the DashboardId property contains the full path to the dashboard file.

If the dashboard has been provided at runtime, the DashboardId property contains the identifier assigned to the ASPxDashboard.InitialDashboardId property.

To identify the data source for which the event is raised, use the DataLoadingEventArgs.DataSourceName property.

To provide data, use the DataLoadingEventArgs.Data property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DashboardId 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#

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

string[] names = e.DataId.Split("|".ToCharArray());
List<DashboardSqlDataSource> dataSources = (List<DashboardSqlDataSource>)Session["ds" + e.DashboardId];
DashboardSqlDataSource dataSource = dataSources.First(ds => ds.ComponentName == names[1]);

VB.NET

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

Dim names() As String = e.DataId.Split("|".ToCharArray())
Dim dataSources As List(Of DashboardSqlDataSource) = DirectCast(Session("ds" & e.DashboardId), List(Of DashboardSqlDataSource))
Dim dataSource As DashboardSqlDataSource = dataSources.First(Function(ds) ds.ComponentName = names(1))