DashboardControl.SetDashboardState(DashboardState) Method

Applies the dashboard state to the loaded dashboard.

Namespace: DevExpress.DashboardWpf

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

NuGet Package: DevExpress.Wpf.Dashboard

Declaration

C#

public void SetDashboardState(
    DashboardState state
)

VB.NET

Public Sub SetDashboardState(
    state As DashboardState
)

Parameters

Name	Type	Description
state	DashboardState	A DashboardState object.

Remarks

The following code snippet sets the created dashboard state:

C#

using DevExpress.DashboardCommon;
using System;
using System.Collections.Generic;
using System.Windows;
using System.Xml.Linq;

namespace WpfDashboard_DashboardState
{
    public partial class MainWindow : Window
    {
        public static readonly string PropertyName = "DashboardState";

        public MainWindow()
        {
            InitializeComponent();

        }

        public DashboardState CreateDashboardState() {
            DashboardState state = new DashboardState();
            // Set a range for a Range Filter.
            state.Items.Add(new DashboardItemState("rangeFilterDashboardItem1") {
                RangeFilterState = new RangeFilterState(new RangeFilterSelection(new DateTime(2015, 1, 1), new DateTime(2017, 1, 1)))
            });
            // Specify master filter and drill-down values.
            state.Items.Add(new DashboardItemState("gridDashboardItem1") {
                MasterFilterValues = new List<object[]>() { new object[] { "Gravad lax" }, new object[] { "Ikura" } },
                DrillDownValues = new List<object>() { "Seafood" }
            });
            // Set a dashboard item layer.
            state.Items.Add(new DashboardItemState("treemapDashboardItem1") {
                SelectedLayerIndex = 1
            });
            // Specify a default tab page.
            state.Items.Add(new DashboardItemState("tabContainerDashboardItem1") {
                TabPageName = "dashboardTabPage2"
            });
            // Define a dashboard parameter value.
            state.Parameters.Add(new DashboardParameterState() {
                Name = "ParameterCountry",
                Value = "UK",
                Type = typeof(string)
            });
            return state;
        }

        private void dashboardControl_DashboardLoaded(object sender, DevExpress.DashboardWpf.DashboardLoadedEventArgs e) {
            var state = CreateDashboardState();
            dashboardControl.SetDashboardState(state);
        }
    }
}

VB.NET

using DevExpress.DashboardCommon;
using System;
using System.Collections.Generic;
using System.Windows;
using System.Xml.Linq;

namespace WpfDashboard_DashboardState
{
    public partial class MainWindow : Window
    {
        public static readonly string PropertyName = "DashboardState";

        public MainWindow()
        {
            InitializeComponent();

        }

        Public Function CreateDashboardState() As DashboardState
          Dim state As New DashboardState()
          ' Set a range for a Range Filter.
          state.Items.Add(New DashboardItemState("rangeFilterDashboardItem1") With {.RangeFilterState = New RangeFilterState(New RangeFilterSelection(New Date(2015, 1, 1), New Date(2017, 1, 1)))})
          ' Specify master filter and drill-down values.
          state.Items.Add(New DashboardItemState("gridDashboardItem1") With {
            .MasterFilterValues = New List(Of Object())() From {
              New Object() { "Gravad lax" },
              New Object() { "Ikura" }
            },
            .DrillDownValues = New List(Of Object)() From {"Seafood"}
          })
          ' Set a dashboard item layer.
          state.Items.Add(New DashboardItemState("treemapDashboardItem1") With {.SelectedLayerIndex = 1})
          ' Specify a default tab page.
          state.Items.Add(New DashboardItemState("tabContainerDashboardItem1") With {.TabPageName = "dashboardTabPage2"})
          ' Define a dashboard parameter value.
          state.Parameters.Add(New DashboardParameterState() With {.Name = "ParameterCountry", .Value = "UK", .Type = GetType(String)})
          Return state
        End Function

        Private Sub dashboardControl_DashboardLoaded(ByVal sender As Object, ByVal e As DevExpress.DashboardWpf.DashboardLoadedEventArgs)
          Dim state = CreateDashboardState()
          dashboardControl.SetDashboardState(state)
        End Sub
    End Class
End Namespace    

To learn more about a dashboard state, refer to the Manage Dashboard State document.