ASPxDashboardViewer.DashboardId Property

Gets or sets the dashboard identifier.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.dll

Declaration

public string DashboardId { get; set; }
Public Property DashboardId As String

Property Value

Type Default Description
String

String.Empty

A String that specifies the dashboard identifier.

Remarks

Use the DashboardId property to enable loading dashboards at runtime and identify the current dashboard when handling ASPxDashboardViewer events.

By default, the ASPxDashboardViewer loads the dashboard from the location specified by the ASPxDashboardViewer.DashboardSource property. If you assign an identifier to the DashboardId property, the ASPxDashboardViewer will ignore the ASPxDashboardViewer.DashboardSource property and raise the ASPxDashboardViewer.DashboardLoading event to load the dashboard.

In this instance, handle the ASPxDashboardViewer.DashboardLoading event and assign a dashboard XML definition to the event parameter's DashboardLoadingEventArgs.DashboardXml property. To identify which dashboard should be loaded, use the DashboardLoadingEventArgs.DashboardId property that returns the DashboardId property value.

When a dashboard is loaded at runtime, ASPxDashboardViewer passes the DashboardId property value to all event handlers to help you identify this dashboard.

See Also