DashboardParameterState Class

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

Namespace: DevExpress.DashboardCommon

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

Declaration

public class DashboardParameterState
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.

Examples

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.

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

Inheritance

Object
DashboardParameterState
See Also