DashboardViewer.SetDashboardState(DashboardState) Method

Applies the dashboard state to the loaded dashboard.

Namespace: DevExpress.DashboardWin

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

Declaration

C#

public void SetDashboardState(
    DashboardState state
)

VB.NET

Public Sub SetDashboardState(
    state As DashboardState
)

Parameters

Name	Type	Description
state	DashboardState	A DashboardState object that contains the dashboard state information.

Remarks

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

Example

Note

The complete sample project How to Set the Initial Dashboard State in the WinForms Viewer is available in the DevExpress Examples repository.

The following code snippet shows how to save and restore a dashboard state for WinForms Dashboard Viewer:

C#

using DevExpress.DashboardCommon;
using DevExpress.XtraEditors;
using System;
using System.Windows.Forms;
using System.Xml.Linq;

namespace WinFormsViewerSaveAndApplyDashboardState
{
    public partial class ViewerForm1: XtraForm
    {
        DashboardState dState = new DashboardState();
        const string path = @"..\..\Dashboards\dashboardWithSavedState.xml";
        public ViewerForm1() {
            InitializeComponent();
            dashboardViewer.DashboardLoaded += dashboardViewer_DashboardLoaded;
            dashboardViewer.SetInitialDashboardState += dashboardViewer_SetInitialDashboardState;
            dashboardViewer.DashboardSource = path;
        }

        private void dashboardViewer_DashboardLoaded(object sender,
            DevExpress.DashboardWin.DashboardLoadedEventArgs e) {
            XElement data = e.Dashboard.UserData;
                if(data != null) {
                    if(data.Element("DashboardState") != null) {
                        XDocument dStateDocument = XDocument.Parse(data.Element("DashboardState").Value);
                        dState.LoadFromXml(XDocument.Parse(data.Element("DashboardState").Value));
                    }
                }
            }

        private void dashboardViewer_SetInitialDashboardState(object sender,
            DevExpress.DashboardWin.SetInitialDashboardStateEventArgs e) {
            e.InitialState = dState;
        }

        private void ViewerForm1_FormClosing(object sender,FormClosingEventArgs e) {
            dState = dashboardViewer.GetDashboardState();
            XElement userData = new XElement("Root",
                new XElement("DateModified",DateTime.Now),
                new XElement("DashboardState",dState.SaveToXml().ToString(SaveOptions.DisableFormatting)));
            dashboardViewer.Dashboard.UserData = userData;
            dashboardViewer.Dashboard.SaveToXml(path);
        }
    }
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.XtraEditors
Imports System
Imports System.Windows.Forms
Imports System.Xml.Linq

Namespace WinFormsViewerSaveAndApplyDashboardState
    Partial Public Class ViewerForm1
        Inherits XtraForm

        Private dState As New DashboardState()
        Private Const path As String = "..\..\Dashboards\dashboardWithSavedState.xml"
        Public Sub New()
            InitializeComponent()
            AddHandler dashboardViewer.DashboardLoaded, AddressOf dashboardViewer_DashboardLoaded
            AddHandler dashboardViewer.SetInitialDashboardState, AddressOf dashboardViewer_SetInitialDashboardState
            dashboardViewer.DashboardSource = path
        End Sub

        Private Sub dashboardViewer_DashboardLoaded(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardLoadedEventArgs)
            Dim data As XElement = e.Dashboard.UserData
                If data IsNot Nothing Then
                    If data.Element("DashboardState") IsNot Nothing Then
                        Dim dStateDocument As XDocument = XDocument.Parse(data.Element("DashboardState").Value)
                        dState.LoadFromXml(XDocument.Parse(data.Element("DashboardState").Value))
                    End If
                End If
        End Sub

        Private Sub dashboardViewer_SetInitialDashboardState(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.SetInitialDashboardStateEventArgs)
            e.InitialState = dState
        End Sub

        Private Sub ViewerForm1_FormClosing(ByVal sender As Object, ByVal e As FormClosingEventArgs) Handles Me.FormClosing
            dState = dashboardViewer.GetDashboardState()
            Dim userData As New XElement("Root", New XElement("DateModified",Date.Now), New XElement("DashboardState",dState.SaveToXml().ToString(SaveOptions.DisableFormatting)))
            dashboardViewer.Dashboard.UserData = userData
            dashboardViewer.Dashboard.SaveToXml(path)
        End Sub
    End Class
    End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetDashboardState(DashboardState) 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#L31

{
    dashboardViewer1.SetDashboardState(CreateDashboardState()); ;
}));

VB.NET

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

Dim resetStateItem As DashboardToolbarItem = New DashboardToolbarItem("Reset State", New Action(Of DashboardToolbarItemClickEventArgs)(Sub(args)
    dashboardViewer1.SetDashboardState(CreateDashboardState())