DashboardParameterState Class

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

Namespace: DevExpress.DashboardCommon

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

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardParameterState class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspxdashboard-how-to-specify-a-default-dashboard-state-in-code-t513681/CS/WebDashboard_ManualDashboardState/Default.aspx.cs#L18

DashboardParameterState parameterState =
    new DashboardParameterState("countryParameter", "USA", typeof(string));

aspxdashboard-how-to-pass-a-hidden-dashboard-parameter-to-a-custom-sql-query-t491903/CS/ASPxDashboard_CustomParameters/WebForm1.aspx.cs#L23

DashboardState dashboardState = new DashboardState();
DashboardParameterState parameterState =
    new DashboardParameterState("CustomerIdDashboardParameter", "XXX", typeof(string));

asp-net-mvc-dashboard-specify-default-state-in-code/CS/MvcDashboard_DefaultDashboardState/App_Start/CustomDashboardStateService.cs#L11

DashboardParameterState parameterState =
    new DashboardParameterState("countryParameter", "USA", typeof(string));

winforms-dashboard-save-restore-dashboard-state/CS/WinFormsDashboard_DashboardState/Form1.cs#L87

// Define a dashboard parameter value.
state.Parameters.Add(new DashboardParameterState()
{

how-to-update-the-parameter-value-when-the-items-master-filter-state-is-changed-t575012/CS/DXApplication33/Default.aspx.cs#L17

DashboardParameterState parameterState = new DashboardParameterState("OrderID", "10253", typeof(int));

VB.NET

aspxdashboard-how-to-specify-a-default-dashboard-state-in-code-t513681/VB/WebDashboard_ManualDashboardState/Default.aspx.vb#L20

Dim parameterState As New DashboardParameterState("countryParameter", "USA", GetType(String))

aspxdashboard-how-to-pass-a-hidden-dashboard-parameter-to-a-custom-sql-query-t491903/VB/ASPxDashboard_CustomParameters/WebForm1.aspx.vb#L20

Dim dashboardState As New DashboardState()
Dim parameterState As New DashboardParameterState("CustomerIdDashboardParameter", "XXX", GetType(String))
dashboardState.Parameters.Add(parameterState)

asp-net-mvc-dashboard-specify-default-state-in-code/VB/MvcDashboard_DefaultDashboardState/App_Start/CustomDashboardStateService.vb#L11

Dim parameterState As New DashboardParameterState("countryParameter", "USA", GetType(String))

winforms-dashboard-save-restore-dashboard-state/VB/WinFormsDashboard_DashboardState/Form1.vb#L70

' Define a dashboard parameter value.
state.Parameters.Add(New DashboardParameterState() With {.Name = "ParameterCountry", .Value = "UK", .Type = GetType(String)})
Return state

how-to-update-the-parameter-value-when-the-items-master-filter-state-is-changed-t575012/VB/DXApplication33/Default.aspx.vb#L18

Dim dashboardState As DashboardState = New DashboardState()
Dim parameterState As DashboardParameterState = New DashboardParameterState("OrderID", "10253", GetType(Integer))
Dim gridFilterState As DashboardItemState = New DashboardItemState("gridDashboardItem1")

Inheritance

Object

DashboardParameterState