DashboardViewer.SaveDashboardLayout(String) Method

Saves a dashboard layout to an XML file.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v18.2.Win.dll

Declaration

C#

public void SaveDashboardLayout(
    string filePath
)

VB.NET

Public Sub SaveDashboardLayout(
    filePath As String
)

Parameters

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

Remarks

Note that the SaveDashboardLayout / DashboardViewer.LoadDashboardLayout methods are designed to operate with the same dashboard. If a dashboard is changed in DashboardDesigner, we cannot guarantee that DashboardViewer will apply a saved layout to the changed dashboard.

Related GitHub Examples

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

how-to-create-a-dashboard-layout-from-scratch-e5206/CS/Dashboard_LayoutCustomization/Form1.cs#L52

{
    dashboardViewer1.SaveDashboardLayout("DashboardLayout.xml");
}

winforms-dashboard-viewer-item-tabs/CS/TabSupportExample/Form1.cs#L130

    MessageBox.Show(e.DashboardItemName, "Dashboard Item Component Name");
    ((DashboardViewer)sender).SaveDashboardLayout("test_dashboard_layout.xml");
}))

VB.NET

how-to-create-a-dashboard-layout-from-scratch-e5206/VB/Dashboard_LayoutCustomization/Form1.vb#L48

Private Sub SaveLayoutToFile(ByVal args As DashboardToolbarItemClickEventArgs)
    dashboardViewer1.SaveDashboardLayout("DashboardLayout.xml")
End Sub

winforms-dashboard-viewer-item-tabs/VB/TabSupportExample/Form1.vb#L121

    MessageBox.Show(e.DashboardItemName, "Dashboard Item Component Name")
    DirectCast(sender, DashboardViewer).SaveDashboardLayout("test_dashboard_layout.xml")
End Sub)) With {.ButtonImage = Image.FromFile("Support_16x16.png")})