Eclipse BIRT Report Object Model (ROM)

SelectionChoice Structure

Structure Overview

Describes one item in a static parameter selection list.

Details

Display Name: Selection Choice
Since: 1.0

Property Summary

label
An externalizable label for the choice.
labelID
value
The parameter value for this choice.

Description

A static selection list defines a set of property choice values. Each choice provides two values: an internal value and a display value. For example, the display values might be "Residential", "Commercial", and "Government" while the corresponding parameter values are "R", "C", and "G". Display values can be localized.

Property Detail

label Property

An externalizable label for the choice.

Details

Type: string
Since: 1.0
Required: No
Display Name: Label
JavaScript Type:
Default Value: None
Runtime Settable: No

Description

An externalizable label for the choice. If omitted, then the internal value is shown as the label.


labelID Property

Details

Type: string
Since: 1.0
Required: No
Display Name: Label Resource Key
JavaScript Type:
Default Value: None
Runtime Settable: Yes

value Property

The parameter value for this choice.

Details

Type: literalString
Since: 1.0
Required: Yes
Display Name: Value
JavaScript Type:
Default Value: None
Runtime Settable: No

Description

The parameter value for this choice. This is the value passed to the report when the user selects this choice. The value must agree with the parameter data type. The value cannot be localized.