ParameterGroup

Visual grouping of report parameters.

Description

A parameter group creates a visual grouping of parameters. The developer controls the order that groups appear in the UI, and the order in which parameters appear in the group. A runtime UI may choose to allow the user to expand & collapse parameter groups independently.

Inherited Properties

name
The internal name of the group. The name must be unique among parameters and parameter groups. The user will see this name unless the display name is defined. The name cannot be externalized.
displayName
The name displayed to the end-user for the group.
extends
A parameter group can extend a group defined in a library. In this case, the report will include all parameters from the library group. The application cannot change the set of parameters within the group. If the application wishes to change the group; create a new group within the report and add the parameters that should appear for the report.

See Also

helpText

Additional pop-up help text associated with the group.

Description

Additional pop-up help text associated with the group. This text can explain the purpose of the group, or provide overall explanation of how a set of parameters work together. The help text can be localized.

helpTextID

Resource key for the help text.

Description

Resource bundle key for the localizable help text.

See Also

startExpanded

Whether the group should start expanded in the UI, or start collapsed.

Description

If the UI can expand and collapse groups, then the UI should assume that groups appear in "collapsed" form by default. Use this attribute to cause the group to appear expanded by default instead. Ignored if the UI does not support group expand/collapse.

See Also

parameters

The set of parameters that appear inside the group.

Description

The set of parameters that appear inside the group. The UI should ignore the group is empty. Parameters appear in the UI in the same order that they appear in this list.

See Also