Defines a simple single-value parameter.
This element defines a single-value parameter. Scalar parameters can have selection lists.
Scalar parameters can provide a selection list. The list
can be static (defined by the selectionList
property) or dynamic (defined by the dataSet
,
valueExpr
and labelExpr
properties.) The user can be required to select a value from the list, or can
enter a value not in the list (as controlled by the
mustMatch
property).
BIRT uses the following rules to determine the selection list:
selectionList
property
defaultValue
property
The default value of the parameter.
The default value for the parameter. The default value can be an expression, but cannot reference any other parameters.
Hides the user’s entry by displaying asterisks or similar characters. Often used for passwords.
This property hides the user’s entry by displaying asterisks or similar characters. Often used for passwords. The default is to show the entry in plain text.
hidden
Property
Formatting pattern for showing the parameter in the UI.
Formatting instructions for the parameter value within the parameter UI. For UIs that are able to show formatted parameter values, provides a BIRT format used to display the value. The format is dropped, and the unformatted value presented, when the user edits the parameter value.
Formatting instructions for the parameter value within the parameter UI. By default the UI should use the following rules:
The format string must be one of the valid BIRT format strings (see the Style element for a list.) The format is used by the UI to display the value after the user moves away from a field. For example, to format a number as a dollar amount.
The suggested type of UI control to use when displaying the parameter.
The suggested type of UI control to use when displaying the parameter. The default depends on the parameter properties:
The list-box control is rendered in the UI depending on the value of the
mustMatch
property. If mustMatch
is true, then the user much choose a value from
the list, and the control is rendered as a UI list box. However, if mustMatch
is
false, then the user can chose an item from the list, or type in a different
value, and the control is rendered as a UI combo box.
mustMatch
property
How the items should appear in the UI. Choices are auto (default), left, center or right.
How the items should appear in the UI. Choices are auto (default), left, center or right.
mustMatch
property
fixedOrder
property
controlType
property
If true, then the value that the user provides must match one of the values in the static or dynamic selection list.
If true, then the value that the user provides must match one of the values in the list. If false, then the values in the list are a reference; the use can enter additional values as well. Ignored if the property does not have a selection list.
Whether to display the list sorted in unsorted (fixed) order.
Whether to display the values in the order defined in the list, or whether to resort the list lexicographically based on the actual translated values. The default is true, and the selections are displayed in the order in which they are defined.
selectionList
property
dynamicList
property
This element defines or references a query that defines a dynamic selection list for the parameter. The data set can reference other parameters, but only those that appear in the design before this parameter. Sorting can be done by the data set (if the fixedOrder property is true), or can be done by BIRT (if the fixedOrder property is false.)
The data set must return a column that contains the choice values. It may also contain a column that returns the labels for the values. All other columns are ignored. The choice is that passed to the report when run. The optional display value is shown to the user in the UI. For example, the display values might be “Residential?, “Commercial?, and “Government? while the corresponding parameter values are “R?, “C?, and “G?.
Bindings the data set column and expressions with the property values..
Property values of a scalar parameter can bind to a data set column through bound data columns' names. If a data set column or expression are not bound in the data columns, the exeuction of the expression fails.