DashboardParameter Class

A dashboard parameter.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class DashboardParameter :
    Parameter,
    INameContainer,
    INamedItem,
    ISupportPrefix

VB.NET

Public Class DashboardParameter
    Inherits Parameter
    Implements INameContainer,
               INamedItem,
               ISupportPrefix

Remarks

A dashboard exposes the Dashboard.Parameters property that provides access to the collection of dashboard parameters. To learn how to use dashboard parameters in code, refer to the Examples section.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardParameter 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#

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DashboardMerger/ParametersMerger.cs#L13

foreach(DashboardParameter parameter in fromParameters) {
    AddParamterCopy(parameter, dashboardMerger, (parameterCopy) => {

how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-e5148/CS/Dashboard_OlapFiltering/Form1.cs#L25

settings.ValueMember = fieldCountryName;
DashboardParameter parameter1 = new DashboardParameter("Parameter1",
    typeof(string), countryCanada, "Category", true, settings);

how-to-pass-a-dashboard-parameter-to-a-custom-sql-query-in-code-e5120/CS/Dashboard_ParametersAndCustomSQL/Form1.cs#L17

staticSettings.Values = new string[] { "2014", "2015", "2016" };
DashboardParameter yearParameter = new DashboardParameter("yearParameter",
    typeof(string), "2015", "Select year:", true, staticSettings);

how-to-pass-a-dashboard-parameter-to-a-calculated-fields-expression-in-code-e5135/CS/Dashboard_ParametersAndCalculatedFileds/Form1.cs#L18

settings.Values = new string[] { "0.01", "0.05", "0.1" };
DashboardParameter discountValue = new DashboardParameter("discountValue",
    typeof(double), 0.05, "Select discount:", true, settings);

aspxdashboard-how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-t481105/CS/ASPxDashboard_OlapFiltering/WebForm1.aspx.cs#L27

settings.ValueMember = fieldCountryName;
DashboardParameter parameter1 = new DashboardParameter("Parameter1",
    typeof(string), countryCanada, "Category", true, settings);

VB.NET

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DashboardMerger/ParametersMerger.vb#L17

For Each parameter As DashboardParameter In fromParameters
    AddParamterCopy(parameter, dashboardMerger, Sub(parameterCopy)

how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-e5148/VB/Dashboard_OlapFiltering/Form1.vb#L27

settings.ValueMember = fieldCountryName
Dim parameter1 As New DashboardParameter("Parameter1", GetType(String), countryCanada, "Category", True, settings)
dashboard.Parameters.Add(parameter1)

how-to-pass-a-dashboard-parameter-to-a-custom-sql-query-in-code-e5120/VB/Dashboard_ParametersAndCustomSQL/Form1.vb#L19

staticSettings.Values = New String() { "2014", "2015", "2016" }
Dim yearParameter As New DashboardParameter("yearParameter", GetType(String), "2015", "Select year:", True, staticSettings)
dashboard.Parameters.Add(yearParameter)

how-to-pass-a-dashboard-parameter-to-a-calculated-fields-expression-in-code-e5135/VB/Dashboard_ParametersAndCalculatedFileds/Form1.vb#L19

settings.Values = New String() { "0.01", "0.05", "0.1" }
Dim discountValue As New DashboardParameter("discountValue", GetType(Double), 0.05, "Select discount:", True, settings)
dashboard.Parameters.Add(discountValue)

aspxdashboard-how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-t481105/VB/ASPxDashboard_OlapFiltering/WebForm1.aspx.vb#L28

settings.ValueMember = fieldCountryName
Dim parameter1 As New DashboardParameter("Parameter1", GetType(String),
                                         countryCanada, "Category", True, settings)

Inheritance

Object

Parameter

DashboardParameter