ASPxDashboard.InitialDashboardId Property

Gets or sets the identifier of the dashboard to be loaded to ASPxDashboard.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v24.1.Web.WebForms.dll

NuGet Package: DevExpress.Web.Dashboard

Declaration

C#

[DefaultValue("")]
public string InitialDashboardId { get; set; }

VB.NET

<DefaultValue("")>
Public Property InitialDashboardId As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the identifier of the dashboard to be loaded to ASPxDashboard.

Remarks

Initialize the InitialDashboardId property to load a dashboard with the specified identifier from the dashboard storage. To learn more about different methods of loading a dashboard, see Loading a Dashboard.

Note that the InitialDashboardId property can be used only on the initial page loading (in the Page_Load event handler).

Note

If you are using the DashboardFileStorage, use the name of the dashboard XML file without an extension as a dashboard identifier.

Related GitHub Examples

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

    ASPxDashboardObjectDS.DataLoading += ASPxDashboardObjectDS_DataLoading;
    ASPxDashboardObjectDS.InitialDashboardId = "dashboardObjectDS";
}

VB.NET

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

    ASPxDashboardEf.SetDataSourceStorage(dataSourceStorage)
    ASPxDashboardEf.InitialDashboardId = "dashboardEf"
End Sub