Back to Devexpress

ASPxDashboard.DashboardXmlPath Property

dashboard-devexpress-dot-dashboardweb-dot-aspxdashboard-a10d2b5b.md

latest6.1 KB
Original Source

ASPxDashboard.DashboardXmlPath Property

Gets or sets the path to the XML definition of a dashboard to be loaded to ASPxDashboard.

Namespace : DevExpress.DashboardWeb

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

NuGet Package : DevExpress.Web.Dashboard

Declaration

csharp
[DefaultValue("")]
public string DashboardXmlPath { get; set; }
vb
<DefaultValue("")>
Public Property DashboardXmlPath As String

Property Value

TypeDefaultDescription
StringString.Empty

A String that specifies the path to the XML definition of a dashboard to be loaded to ASPxDashboard.

|

Remarks

An XML file should be located on the server.

To learn more about different methods of loading a dashboard, see Loading a Dashboard.

Note

Note that if you load a dashboard using DashboardXmlPath or ASPxDashboard.OpenDashboard, end-users will not be able to create new dashboards. To allow end-users to create new dashboards, create dashboard storage using ASPxDashboard.DashboardStorageFolder or ASPxDashboard.SetDashboardStorage.

Example

The code snippet below shows how to display the dashboard stored in the XML file using the ASPxDashboard.DashboardXmlPath property.

csharp
ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/MyDashboard.xml");
vb
ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/MyDashboard.xml")

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardXmlPath 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.

asp-net-web-forms-dashboard-perform-drill-down-in-code/CS/ASPxDashboard_PerformDrillDown/Default.aspx.cs#L9

csharp
{
    ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/dashboard1.xml");
}

asp-net-web-forms-dashboard-apply-master-filter-in-code/CS/WebDashboard_SetMasterFilter/Default.aspx.cs#L6

csharp
protected void Page_Load(object sender, EventArgs e) {
    ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/Dashboard.xml");
}

web-forms-dashboard-specify-dashboard-parameter-values-on-the-client/CS/ASPxDashboard_SetParameterValues/Default.aspx.cs#L6

csharp
protected void Page_Load(object sender, EventArgs e) {
    ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/dashboard1.xml");
}

asp-net-web-forms-dashboard-perform-drill-down-in-code/VB/ASPxDashboard_PerformDrillDown/Default.aspx.vb#L9

vb
Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/dashboard1.xml")
End Sub

asp-net-web-forms-dashboard-apply-master-filter-in-code/VB/WebDashboard_SetMasterFilter/Default.aspx.vb#L8

vb
Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/Dashboard.xml")
End Sub

web-forms-dashboard-specify-dashboard-parameter-values-on-the-client/VB/ASPxDashboard_SetParameterValues/Default.aspx.vb#L9

vb
Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxDashboard1.DashboardXmlPath = Server.MapPath("App_Data/dashboard1.xml")
End Sub

See Also

Load a Dashboard in ASP.NET Web Forms

ASPxDashboard Class

ASPxDashboard Members

DevExpress.DashboardWeb Namespace