DashboardDesigner.LoadDashboard(String) Method

Loads a dashboard from an XML file.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.1.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public void LoadDashboard(
    string filePath
)

VB.NET

Public Sub LoadDashboard(
    filePath As String
)

Parameters

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

Remarks

You can open a dashboard in one of the following ways.

• Create and assign an instance of the Dashboard class to the DashboardDesigner.Dashboard property.
• Use the LoadDashboard method to open a dashboard from a file or stream.

To save a dashboard to a file or a stream, use the Dashboard.SaveToXml method. You can use the Dashboard.LoadFromXml method to load a dashboard definition from a file or a stream to the existing dashboard.

Note

If the DashboardDesigner / DashboardViewer control is placed in the MDI child form, load dashboards in the Shown event handler instead of Load.

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

dashboardDesigner1.LoadDashboard("../../Data/dashboard1.xml");

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDashboard(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-async-mode-designer-data-loading/CS/DashboardDesignerAsyncModeExample/Form1.cs#L36

    lblMode.Text = "ASYNC";
    dashboardDesigner1.LoadDashboard("test.xml");
}

how-to-evaluate-a-customer-acquisition-using-the-quarter-year-of-their-first-purchase-t372353/CS/Dashboard_AggrCohortAnalysis/Form1.cs#L8

    dashboardDesigner1.CreateRibbon();
    dashboardDesigner1.LoadDashboard(@"..\..\Data\CohortAnalysis.xml");
}

winforms-dashboard-display-best-and-worst-monthly-sales/CS/Dashboard_AggrSalesByMonths/Form1.cs#L8

    dashboardDesigner1.CreateRibbon();
    dashboardDesigner1.LoadDashboard(@"..\..\Data\SalesByMonths.xml");
}

winforms-dashboards-how-to-use-a-custom-format-for-axis-labels-in-the-chart-item/CS/DesignerSample/Form1.cs#L19

    dashboardDesigner1.CreateRibbon();
    dashboardDesigner1.LoadDashboard(@"..\..\Data\T597204.xml");
}

winforms-dashboard-custom-save-and-open-procedures/CS/Dashboard_LoadingAndSaving/Form1.cs#L34

DevExpress.DashboardWin.DashboardOpeningEventArgs e) {
dashboardDesigner1.LoadDashboard(filePath);
e.Handled = true;

VB.NET

winforms-dashboard-async-mode-designer-data-loading/VB/DashboardDesignerAsyncModeExample/Form1.vb#L36

    lblMode.Text = "ASYNC"
    dashboardDesigner1.LoadDashboard("test.xml")
End Sub

how-to-evaluate-a-customer-acquisition-using-the-quarter-year-of-their-first-purchase-t372353/VB/Dashboard_AggrCohortAnalysis/Form1.vb#L10

    dashboardDesigner1.CreateRibbon()
    dashboardDesigner1.LoadDashboard("..\..\Data\CohortAnalysis.xml")
End Sub

winforms-dashboard-display-best-and-worst-monthly-sales/VB/Dashboard_AggrSalesByMonths/Form1.vb#L11

    dashboardDesigner1.CreateRibbon()
    dashboardDesigner1.LoadDashboard("..\..\Data\SalesByMonths.xml")
End Sub

winforms-dashboards-how-to-use-a-custom-format-for-axis-labels-in-the-chart-item/VB/DesignerSample/Form1.vb#L18

    dashboardDesigner1.CreateRibbon()
    dashboardDesigner1.LoadDashboard("..\..\Data\T597204.xml")
End Sub

winforms-dashboard-custom-save-and-open-procedures/VB/Dashboard_LoadingAndSaving/Form1.vb#L34

Private Sub dashboardDesigner1_DashboardOpening(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardOpeningEventArgs) Handles dashboardDesigner1.DashboardOpening
    dashboardDesigner1.LoadDashboard(filePath)
    e.Handled = True

Implements

LoadDashboard(String)