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.v20.2.Web.WebForms.dll

NuGet Package: DevExpress.Web.Dashboard

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.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.

C#

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

VB.NET

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

Related GitHub Examples

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.

C#

asp-net-web-forms-dashboard-get-underlying-data-for-clicked-item/CS/ASPxDashboard_UnderlyingData/WebForm1.aspx.cs#L9

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

web-forms-dashboard-underlying-widgets-api/CS/ASPxDashboard_UnderlyingWidgets/Default.aspx.cs#L9

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

web-forms-dashboard-apply-master-filtering-in-olap/CS/ASPxDashboard_SetMasterFilter_Olap/Default.aspx.cs#L9

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

web-forms-dashboard-color-dashboard-item-elements/CS/ASPxDashboard_ElementCustomColor/WebForm1.aspx.cs#L9

{
    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

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

VB.NET

asp-net-web-forms-dashboard-get-underlying-data-for-clicked-item/VB/ASPxDashboard_UnderlyingData/WebForm1.aspx.vb#L9

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

web-forms-dashboard-underlying-widgets-api/VB/ASPxDashboard_UnderlyingWidgets/Default.aspx.vb#L9

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

web-forms-dashboard-apply-master-filtering-in-olap/VB/ASPxDashboard_SetMasterFilter_Olap/Default.aspx.vb#L8

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

web-forms-dashboard-color-dashboard-item-elements/VB/ASPxDashboard_ElementCustomColor/WebForm1.aspx.vb#L9

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#L9

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