Dashboard.SaveToXml(String) Method

Saves the dashboard to the specified XML file.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public void SaveToXml(
    string filePath
)

VB.NET

Public Sub SaveToXml(
    filePath As String
)

Parameters

Name	Type	Description
filePath	String	A String that specifies the path to a file to which the dashboard should be saved.

Remarks

To save a dashboard to a stream, use another overload of the SaveToXml method that takes a stream parameter.

To load a dashboard from a file or stream, use the Dashboard.LoadFromXml method.

The following code snippet shows how to save a dashboard to the project’s Data folder when you click a button:

C#

private void button1_Click(object sender, System.EventArgs e) {
  dashboardControl1.Dashboard.SaveToXml("..\\..\\Data\\Dashboard.xml");
}

VB.NET

Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    dashboardControl1.Dashboard.SaveToXml("..\..\Data\Dashboard.xml")
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveToXml(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-custom-save-and-open-procedures/CS/Dashboard_LoadingAndSaving/Form1.cs#L16

if (e.Command == DevExpress.DashboardWin.DashboardSaveCommand.Save) {
    dashboardDesigner1.Dashboard.SaveToXml(filePath);
    e.Handled = true;

winforms-dashboard-save-restore-dashboard-state/CS/WinFormsDashboard_DashboardState/Form1.cs#L59

    dashboardViewer1.Dashboard.CustomProperties.SetValue("DashboardState", stateValue);
    dashboardViewer1.Dashboard.SaveToXml(path);
}

winforms-designer-save-and-apply-dashboard-state/CS/WinDesignerDashboardState/DesignerForm1.cs#L36

    dashboardDesigner.Dashboard.CustomProperties.SetValue("DashboardState", stateValue);
    dashboardDesigner.Dashboard.SaveToXml(path);
}

winforms-viewer-save-and-apply-dashboard-state/CS/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.cs#L37

    dashboardViewer.Dashboard.CustomProperties.SetValue("DashboardState", stateValue);
    dashboardViewer.Dashboard.SaveToXml(path);
}

winforms-dashboard-extract-data-source/CS/ExtractDataSourceExample/Form1.cs#L33

    dashboardViewer1.Dashboard.DataSources.RemoveRange(dsCollection);
    dashboardViewer1.Dashboard.SaveToXml("Dashboard_Extract.xml");
}

VB.NET

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

If e.Command = DevExpress.DashboardWin.DashboardSaveCommand.Save Then
    dashboardDesigner1.Dashboard.SaveToXml(filePath)
    e.Handled = True

winforms-dashboard-save-restore-dashboard-state/VB/WinFormsDashboard_DashboardState/Form1.vb#L50

    dashboardViewer1.Dashboard.CustomProperties.SetValue("DashboardState", stateValue)
    dashboardViewer1.Dashboard.SaveToXml(path)
End Sub

winforms-designer-save-and-apply-dashboard-state/VB/WinDesignerDashboardState/DesignerForm1.vb#L35

    dashboardDesigner.Dashboard.CustomProperties.SetValue("DashboardState", stateValue)
    dashboardDesigner.Dashboard.SaveToXml(path)
End Sub

winforms-viewer-save-and-apply-dashboard-state/VB/WinFormsViewerSaveAndApplyDashboarState/ViewerForm1.vb#L36

    dashboardViewer.Dashboard.CustomProperties.SetValue("DashboardState", stateValue)
    dashboardViewer.Dashboard.SaveToXml(path)
End Sub

winforms-dashboard-extract-data-source/VB/ExtractDataSourceExample/Form1.vb#L38

    dashboardViewer1.Dashboard.DataSources.RemoveRange(dsCollection)
    dashboardViewer1.Dashboard.SaveToXml("Dashboard_Extract.xml")
End Sub