Parameter
Create a parameter for user input. This function is used in conjunction with the Ask function.
Variants
- Parameter(column)
- Parameter(column, Boolean required)
- Parameter(column, Text label)
- Parameter(column, Text label, Boolean required)
- Parameter(Text label, type)
- Parameter(Text label, type, Boolean required)
Parameter(column)
Enables parameterized searching over the specified column.
Parameters
- column
- The column for which to prompt the value.
Returns
The entered column value.
Remarks
The Parameter([Column]) function is equivalent to the following short form: [?Column].
Examples
Ask([State] = Parameter([State])): This formula requires the user to input a State value, which will then be used as a filter criterion.
Parameter(Column, Boolean required)
Enables the creation of a parameterized search for the specified column, with an option to require user input.
Parameters
- column
- The column for which to prompt the value.
- required
- Set to true to make user input mandatory for this parameter.
Returns
The entered column value.
Examples
Ask([State] = Parameter([State], true)): This formula requires the user to enter a State value, which will be used as a mandatory filter criterion.
Parameter(column, Text label)
Enables parameterized searching over the specified column and allows the use of a custom label instead of the column name.
Parameters
- column
- The column for which to prompt the value.
- label
- The text value to display in the user prompt instead of the column name.
Returns
The entered column value.
Examples
Ask([Date of Shipment] = Parameter([Date of Shipment], "Date")): The label "Date" is displayed instead of the column name "Date of Shipment". The user should enter a value in the "Date" field, which will be used as a filter criterion.
Parameter(column, Text label, Boolean required)
Enables the creation of a required parameterized search for the specified column and allows the use of a custom label instead of the column name.
Parameters
- column
- The column for which to prompt the value.
- label
- The text value to display in the user prompt instead of the column name.
- required
- Set to true to make user input mandatory for this parameter.
Returns
The entered column value.
Examples
Ask([Date of Shipment] = Parameter([Date of Shipment], "Date", true)): The label "Date" is displayed instead of the column name "Date of Shipment". The user must enter a value in the "Date" field, which will be used as a required filter criterion.
Parameter(Text label, type)
Creates a parameter with the specified name and type without referencing a column.
Parameters
- label
- The parameter name to display in the user prompt.
- type
- The parameter type. Allowed values are: Text, Bool, Date, Time, Timestamp, Numeric, Duration, User, Location.
Returns
The entered parameter value.
Examples
Ask(Month([Date]) = Parameter("Month", Numeric)): This formula requires the user to enter a numeric value for the Month parameter. The entered value will be used as a filter criterion and will be searched in the Date column.
Parameter(Text label, type, Boolean required)
Creates a required parameter with the specified name and type without referencing a column.
Parameters
- label
- The parameter name to display in the user prompt.
- type
- The parameter type. Allowed values are: Text, Bool, Date, Time, Timestamp, Numeric, Duration, User, Location.
- required
- Set to true to make user input mandatory for this parameter.
Returns
The entered parameter value.
Examples
Ask(Month([Date]) = Parameter("Month", Numeric, true)): This formula requires the user to enter a required numeric value for the Month parameter. The entered value will be used as a filter criterion and will be searched in the Date column.