Back to Devexpress

DashboardDesigner.GetDashboardState() Method

dashboard-devexpress-dot-dashboardwin-dot-dashboarddesigner-93ee4abb.md

latest3.4 KB
Original Source

DashboardDesigner.GetDashboardState() Method

Gets the current dashboard state.

Namespace : DevExpress.DashboardWin

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

NuGet Package : DevExpress.Win.Dashboard

Declaration

csharp
public DashboardState GetDashboardState()
vb
Public Function GetDashboardState As DashboardState

Returns

TypeDescription
DashboardState

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

|

Remarks

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

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

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

csharp
private void dashboardDesigner_DashboardClosing(object sender,DevExpress.DashboardWin.DashboardClosingEventArgs e) {
    var dState = dashboardDesigner.GetDashboardState();
    var stateValue = dState.SaveToXml().ToString(SaveOptions.DisableFormatting);

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

vb
Private Sub dashboardDesigner_DashboardClosing(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardClosingEventArgs)
    Dim dState = dashboardDesigner.GetDashboardState()
    Dim stateValue = dState.SaveToXml().ToString(SaveOptions.DisableFormatting)

Implements

GetDashboardState()

See Also

SetInitialDashboardState

SetDashboardState(DashboardState)

DashboardDesigner Class

DashboardDesigner Members

DevExpress.DashboardWin Namespace