Eclipse BIRT Report Object Model (ROM)

DynamicFilterParameter Element

Element Overview

Defines a dynamic filter parameter.

Details

Display Name: Dynamic Filter Parameter
Since: 2.5
XML Element: dynamic-filter-parameter
Extends: AbstractScalarParameter
Extendable: Yes
Abstract: No
Name Space: Parameters
Name Requirement: Required
Allows User Properties: Yes
Has Style: No

Property Summary

column
Refers to the data set column.
controlType
defaultValue
The default value of the parameter.
displayType
The display type for the parameter.
filterOperator
Contains a set of operators.
nativeDataType

Inherited Properties

comments, customXml, dataSetName, dataType, displayName, displayNameID, distinct, eventHandlerClass, extends, helpText, helpTextID, hidden, isRequired, labelExpr, listLimit, name, newHandlerOnEachEvent, promptText, promptTextID, propertyMasks, selectionList, sortBy, sortByColumn, sortDirection, userProperties, valueExpr, valueType, viewAction

Inherited Methods

validate

Description

This element supports dynamic ad hoc parameter feature.

Property Detail

column Property

Refers to the data set column.

Details

Type: string
Since: 2.5
Required: Yes
Display Name: Column
JavaScript Type:
Default Value: None
Inherited: Yes
Runtime Settable: Yes
Property Sheet Visibility: Visible
Property Sheet Group: Top

Description

Refers to the data set column.

See Also

defaultValue property


controlType Property

Details

Type: choice (paramControl)
Since: 2.5
Required: No
Display Name: Control type
JavaScript Type:
Default Value: list-box
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Choices

NameDisplay Name ValueDescription
text-box Text Box text-box
list-box Combo/List Box list-box
radio-button Radio Button radio-button
check-box Check Box check-box
auto-suggest Text Box - Auto Suggest auto-suggest


defaultValue Property

The default value of the parameter.

Details

Type: list
Since: 1.0
Required: No
Display Name: Default value
JavaScript Type:
Default Value: None
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Description

The default value for the parameter. The default value can be an expression, but cannot reference any other parameters.

 


displayType Property

The display type for the parameter.

Details

Type: choice (dynamicFilterChoice)
Since: 2.5
Required: No
Display Name: Display type
JavaScript Type:
Default Value: simple
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Choices

NameDisplay Name ValueDescription
simple Simple simple simple type.
advanced Advanced advanced advanced type.

Description

Identifies it is a simple filter or advanced filter.


filterOperator Property

Contains a set of operators.

Details

Type: list
Since: 2.5
Required: No
Display Name: Filter operator
JavaScript Type:
Default Value: None
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Description

Contains a set of operators.


nativeDataType Property

Details

Type: integer
Since: 2.5.1
Required: No
Display Name: Native data type
JavaScript Type:
Default Value: None
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top