DashboardParameterState Class

A state of dashboard parameters that includes currently selected parameter values.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v20.2.Core.dll

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.WindowsDesktop.Dashboard.Core

Declaration

C#

public class DashboardParameterState

VB.NET

Public Class DashboardParameterState

Remarks

To add a parameter state to the entire dashboard state (DashboardState), use the DashboardState.Parameters property. To learn more about a dashboard state, see the Manage Dashboard State.

Example

View Example: How to Save and Restore the Dashboard State

The following code snippet shows the CreateDashboardState method that adds parameter values to a dashboard state.

The DashboardState object contains states of individual dashboard items and currently selected parameter values. To add a parameter state to the entire dashboard state, use the DashboardState.Parameters property. The DashboardDesigner.SetDashboardState method applies the dashboard state to the loaded dashboard.

C#

using DevExpress.DashboardCommon;
//...
public DashboardState CreateDashboardState() {
    DashboardState state = new DashboardState();
    //...
    state.Parameters.Add(new DashboardParameterState() {
        Name = "ParameterCountry",
        Value = "UK",
        Type = typeof(string)
    });
    return state;
}

VB.NET

Imports DevExpress.DashboardCommon
'...
Public Function CreateDashboardState() As DashboardState
        Dim state As New DashboardState()
        '...
        state.Parameters.Add(New DashboardParameterState() With {.Name = "ParameterCountry", .Value = "UK", .Type = GetType(String)})
        Return state
    End Function

Inheritance

Object

DashboardParameterState