Defines a simple single-value parameter.

The data type for the parameter. The data type controls how the Requester formats, parses and validates the parameter. Every type can optionally provide a choice list. And, the parameter can require that the user select one of the choices.

selectionList property

defaultValue property

The parameter selection list provides a developer-defined list of choices. Every choice has two parts: a choice and a label. The label can be externalized and appears in the UI. The choice is the value passed to the report. For example, labels may be "Open? and "Closed?, while the values are ?0? and ?1?.

The items in the list are of the type given by the parameter data type.

mustMatch property

fixedOrder property

controlType property

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.

 

Type of the parameter, can be static or dynamic

listLimit

List limitation number.

The suggested type of UI control to use when displaying the parameter. The default depends on the parameter properties:

• text-box ? Default for non-Boolean values when no choices are available.
• list-box ? Default for parameters with choices.
• check-box ? Default for Boolean values.

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

An expression on the data row from the dynamic list data set that returns the prompt for the choice. If omitted, then BIRT uses the value as the label.

 

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:

• Text ? No formatting.
• Number, Float, Date-Time ? Default locale formatting.

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.

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.