DashboardParameterState Class

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

Namespace: DevExpress.DashboardCommon

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


public class DashboardParameterState
Public Class DashboardParameterState


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.


This example demonstrates how to manage the dashboard state to save and restore selected master filter values.

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.


The complete sample project CustomFieldSort - How to Use a Hidden Field to Sort the Visible Field is available in the DevExpress Examples repository.

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


See Also