DashboardDesigner.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 Designer is available in the DevExpress Examples repository.

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

C#

using DevExpress.DashboardCommon;
using System;
using System.Xml.Linq;

namespace WinDesignerDashboardState
{
    public partial class DesignerForm1: DevExpress.XtraBars.Ribbon.RibbonForm {

        DashboardState dState = new DashboardState();
        const string path = @"..\..\Dashboards\dashboardWithSavedState.xml";
        public DesignerForm1() {
            InitializeComponent();
            dashboardDesigner.DashboardLoaded += dashboardDesigner_DashboardLoaded;
            dashboardDesigner.DashboardClosing += dashboardDesigner_DashboardClosing;
            dashboardDesigner.SetInitialDashboardState += dashboardDesigner_SetInitialDashboardState;
            dashboardDesigner.CreateRibbon();
            dashboardDesigner.LoadDashboard(path);
        }
        private void dashboardDesigner_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 dashboardDesigner_SetInitialDashboardState(object sender,
            DevExpress.DashboardWin.SetInitialDashboardStateEventArgs e) {
            e.InitialState = dState;
        }

        private void dashboardDesigner_DashboardClosing(object sender,DevExpress.DashboardWin.DashboardClosingEventArgs e) {
            dState = dashboardDesigner.GetDashboardState();
            XElement userData = new XElement("Root",
                new XElement("DateModified",DateTime.Now),
                new XElement("DashboardState",dState.SaveToXml().ToString(SaveOptions.DisableFormatting)));
            dashboardDesigner.Dashboard.UserData = userData;
            dashboardDesigner.Dashboard.SaveToXml(path);
        }
    }
}

VB.NET

Imports DevExpress.DashboardCommon
Imports System
Imports System.Xml.Linq

Namespace WinDesignerDashboardState
    Partial Public Class DesignerForm1
        Inherits DevExpress.XtraBars.Ribbon.RibbonForm

        Private dState As New DashboardState()
        Private Const path As String = "..\..\Dashboards\dashboardWithSavedState.xml"
        Public Sub New()
            InitializeComponent()
            AddHandler dashboardDesigner.DashboardLoaded, AddressOf dashboardDesigner_DashboardLoaded
            AddHandler dashboardDesigner.DashboardClosing, AddressOf dashboardDesigner_DashboardClosing
            AddHandler dashboardDesigner.SetInitialDashboardState, AddressOf dashboardDesigner_SetInitialDashboardState
            dashboardDesigner.CreateRibbon()
            dashboardDesigner.LoadDashboard(path)
        End Sub
        Private Sub dashboardDesigner_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 dashboardDesigner_SetInitialDashboardState(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.SetInitialDashboardStateEventArgs)
            e.InitialState = dState
        End Sub

        Private Sub dashboardDesigner_DashboardClosing(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardClosingEventArgs)
            dState = dashboardDesigner.GetDashboardState()
            Dim userData As New XElement("Root", 
                New XElement("DateModified",Date.Now), 
                New XElement("DashboardState",dState.SaveToXml().ToString(SaveOptions.DisableFormatting)))
            dashboardDesigner.Dashboard.UserData = userData
            dashboardDesigner.Dashboard.SaveToXml(path)
        End Sub
    End Class
End Namespace