View on GitHub

dotnet-eud

.NET Controls End-User Documentation

Creating Parameters

This topic explains how to create a new dashboard parameter and specify its settings.

Creating Parameters in the Dashboard Designer

To create dashboard parameters in the Dashboard Designer, do the following:

  1. Click the Parameters button on the Ribbon’s Data Source tab.

    Parameters_AddParameterButton_Ribbon

  2. In the invoked dialog, click the Add button to add a new parameter.

    Parameters_ParametersDialog

  3. Specify the following settings.

    • Visible - Specifies whether or not the parameter editor is visible in the Dashboard Parameters dialog.
    • Allow Null - Specifies whether or a not null value can be passed as a parameter value.
    • Allow Multiselect - Specifies whether or not multi-selection is enabled for the current parameter. The following limitations are applied to parameters with multi-selection enabled.
      • Use the is any of or is none of operators to pass a multi-select parameter to a filter criteria or to the Expression format condition.
      • Use the In or Not In operators to pass a multi-select parameter to a calculated field expression.
      • Stored procedures used in the SQL data source do not support multi-select parameters.
    • Name - Specifies the parameter name. When creating and modifying parameter names, follow the rules below.
      • A name can contain letters, numbers and underscores.
      • A name cannot contain spaces.
      • A name cannot be an empty string.
      • The dashboard cannot contain parameters with the same name.
      • Names are case-sensitive. For example, you can create the names Parameter and PARAMETER .
    • Description - Specifies the parameter’s description. The parameter’s description is the value displayed in the Parameter Name column of the Dashboard Parameters dialog.
    • Look-Up Settings - Specifies the parameter’s look-up editor settings.
    • Select All Values - Specifies whether or not all parameter values should be selected in the initial state of the Dashboard Viewer.

      Note that this option is in effect when Allow Multiselect is set to true.

    • Type - Specifies the parameter type.
    • Value - Specifies the default parameter’s value. Note that when Allow Multiselect is set to true, the Value option allows you to select multiple parameter values.

    Then, click OK to add the created parameters to the dashboard.

Look-Up Editor Settings

There are three types of look-up editor settings that can be specified for a parameter. Select the required type from the LookUpSettings drop-down list.

Parameters_ParametersDialog_LookUpSettings