Dashboard.LoadFromXml(String) Method

Loads a dashboard from the specified XML file.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v23.2.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public void LoadFromXml(
    string filePath
)

VB.NET

Public Sub LoadFromXml(
    filePath As String
)

Parameters

Name	Type	Description
filePath	String	A String that specifies the path to a file that contains a dashboard.

Remarks

You need a dashboard (a Dashboard instance) to be created to use the Dashboard.LoadFromXml method.

To load a dashboard from a stream, use another overload of the LoadFromXml method that takes a stream parameter. You can use the DashboardDesigner.LoadDashboard / DashboardViewer.LoadDashboard methods as an alternative to the Dashboard.LoadFromXml method.

To save a dashboard to a file or stream, use the Dashboard.SaveToXml method.

The following code snippet shows how to load a dashboard from the project’s folder:

C#

dashboardControl1.Dashboard = new Dashboard();
dashboardControl1.Dashboard.LoadFromXml("Data\\Dashboard.xml");

VB.NET

dashboardControl1.Dashboard = New Dashboard()
dashboardControl1.Dashboard.LoadFromXml("Data\Dashboard.xml")

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadFromXml(String) method.

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#

winforms-dashboard-apply-conditional-formatting-to-grid-cells/CS/Dashboard_ConditionalFormatting_Grid/BarConditionForm.cs#L7

InitializeComponent();
Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
dashboardViewer1.Dashboard = dashboard;

winforms-dashboard-pass-dashboard-parameters-to-expression-format-condition-in-code/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L7

InitializeComponent();
Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
dashboardViewer1.Dashboard = dashboard;

wpf-dashboard-how-to-manage-dashboard-parameters-in-code/CS/WPF_Dashboard_CustomParameters/ViewModels/MyViewModel.cs#L15

Dashboard dashboard = new Dashboard();
dashboard.LoadFromXml("Data\\SampleDashboard.xml");
dashboard.Parameters.Add(CreateParameter());

winforms-dashboard-window-calculation-example/CS/WindowCalculationExample/TabPageLoadHelper.cs#L20

{
    originalDashboard.LoadFromXml(Path.Combine(Environment.CurrentDirectory, xmldashboardFile));
}

winforms-dashboard-customize-color-scheme/CS/Dashboard_Coloring/Form1.cs#L15

// Load a dashboard from the XML file.
Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
IDashboardDataSource dataSource = dashboard.DataSources["dataSource1"];

VB.NET

winforms-dashboard-apply-conditional-formatting-to-grid-cells/VB/Dashboard_ConditionalFormatting_Grid/BarConditionForm.vb#L11

Dim dashboard As New Dashboard()
dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
dashboardViewer1.Dashboard = dashboard

winforms-dashboard-pass-dashboard-parameters-to-expression-format-condition-in-code/VB/Dashboard_ConditionalFormatting_Grid/Form1.vb#L10

Dim dashboard As New Dashboard()
dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
dashboardViewer1.Dashboard = dashboard

wpf-dashboard-how-to-manage-dashboard-parameters-in-code/VB/WPF_Dashboard_CustomParameters/ViewModels/MyViewModel.vb#L15

Dim dashboard_Renamed As New Dashboard()
dashboard_Renamed.LoadFromXml("Data\SampleDashboard.xml")
dashboard_Renamed.Parameters.Add(CreateParameter())

winforms-dashboard-window-calculation-example/VB/WindowCalculationExample/TabPageLoadHelper.vb#L50

Public Sub New(ByVal xmldashboardFile As String)
    originalDashboard.LoadFromXml(Path.Combine(Environment.CurrentDirectory, xmldashboardFile))
End Sub

winforms-dashboard-customize-color-scheme/VB/Dashboard_Coloring/Form1.vb#L18

Dim dashboard As New Dashboard()
dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
Dim dataSource As IDashboardDataSource = dashboard.DataSources("dataSource1")