DashboardViewer.GetDashboardState() Method

Gets the current dashboard state.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public DashboardState GetDashboardState()

VB.NET

Public Function GetDashboardState As DashboardState

Returns

Type	Description
DashboardState	A DashboardState object that contains modifications produced by end-user interaction.

Remarks

Refer to the Manage Dashboard State document for details about a dashboard state.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDashboardState() 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-save-restore-dashboard-state/CS/WinFormsDashboard_DashboardState/Form1.cs#L56

{
    var state = dashboardViewer1.GetDashboardState();
    var stateValue = state.SaveToXml().ToString(SaveOptions.DisableFormatting);

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

private void ViewerForm1_FormClosing(object sender,FormClosingEventArgs e) {
    var dState = dashboardViewer.GetDashboardState();
    var stateValue = dState.SaveToXml().ToString(SaveOptions.DisableFormatting);

VB.NET

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

Private Sub Form1_FormClosing(ByVal sender As Object, ByVal e As FormClosingEventArgs)
    Dim state = dashboardViewer1.GetDashboardState()
    Dim stateValue = state.SaveToXml().ToString(SaveOptions.DisableFormatting)

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

Private Sub ViewerForm1_FormClosing(ByVal sender As Object, ByVal e As FormClosingEventArgs) Handles Me.FormClosing
    Dim dState = dashboardViewer.GetDashboardState()
    Dim stateValue = dState.SaveToXml().ToString(SaveOptions.DisableFormatting)

Implements

GetDashboardState()