Back to Devexpress

DashboardControl.GetDashboardState() Method

dashboard-devexpress-dot-dashboardwpf-dot-dashboardcontrol-1ab845fa.md

latest3.2 KB
Original Source

DashboardControl.GetDashboardState() Method

Gets the current dashboard state.

Namespace : DevExpress.DashboardWpf

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

NuGet Package : DevExpress.Wpf.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 details 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.

wpf-dashboard-how-to-set-initial-dashboard-state/CS/WpfDashboard_DashboardState/MainWindow.xaml.cs#L40

csharp
{
    var dState = dashboardControl.GetDashboardState();
    var stateValue = dState.SaveToXml().ToString(SaveOptions.DisableFormatting);

wpf-dashboard-how-to-set-initial-dashboard-state/VB/WpfDashboard_DashboardState/MainWindow.xaml.vb#L34

vb
Private Sub Window_Closing(ByVal sender As Object, ByVal e As System.ComponentModel.CancelEventArgs)
    Dim dState = dashboardControl.GetDashboardState()
    Dim stateValue = dState.SaveToXml().ToString(SaveOptions.DisableFormatting)

Implements

GetDashboardState()

See Also

SetDashboardState(DashboardState)

SetInitialDashboardState

DashboardControl Class

DashboardControl Members

DevExpress.DashboardWpf Namespace