Condition

TOPICA Basic expression (string)

The TOPICA Basic expression is evaluated - it should return a Boolean value.

false: The parameter does not generate any input control, nor is the parameter value passsed to the report.

true: The parameter generates input control in the report start-up form (except when ParamType="Context", see below), and the parameter value is passed to the report.

ParamName

String

The name to be used in the report to access the value of the paramater.

ParamLabel

String

The label displayed in the user interface.

If not specified, the value of ParamName is used.

ParamType

String

The type of the parameter. Legal values:

ExpressionString

String

For ParamType="Context" the content is evaluated as a TOPICA Basic expression, and the resulting value is passed to the report.

For types DropDownList and ListBox, the content must be an SQL query, which may or may have embedded TOPICA Basic expressions. First, any embedded expresssions are evaluated and substituted. The resulting string must be a valid SQL query, that returns (as a minimum) 2 columns with these names: Value and Text.

The Value column defines the values that may be sent to the report.

The Text column defines the strings displayed in the dropdown / listbox.

ParamChecked

String (TOPICA Basic expression)

Only used when ParamType="CheckBox"

The TOPICA Basic expression is evaluated - it should evaluate to a boolean value.

The evaluated boolean value controls the initila (default) state of the checkbox. The user may change this value.

MultiValue

String (TOPICA Basic expression)

This attribute only has effect for ParamType="ListBox".

The TOPICA Basic expression is evaluated - it should evaluate to a Boolean value.

false: user can select only one value from the listbox.

true: user may select any number of values in the listbox.

Default value is true for backward compatibility reasons.

SelectAll

String (TOPICA Basic expression)

This attribute only has effect for ParamType="ListBox".

The TOPICA Basic expression is evaluated - it should evalute to a Boolean value.

false: no values in the listbox is initially selected.

true: all values in the listbox are initially selected.

Default value is true.

Description

String - with optional embedded TOPICA Basic expressions.

The resulting text is displayed to the right of the actual paramater. May be used to display guidance etc.

Tooltip

String - with optional embedded TOPICA Basic expressions.

The resulting text is displayed as a tooltip when the mouse cursor hovers over the row for the actual parameter.

Note that the Internet Explorer browser does NOT display tooltip, when the mouse cursor hovers over a listbox!