Eclipse BIRT Report Object Model (ROM)

ParamBinding Structure

Structure Overview

Represents an association between an expression and a data set or nested report input parameter.

Details

Display Name: Parameter Binding
Since: 1.0

Property Summary

expression
An expression used to compute the value of the parameter.
paramName
The name of an input parameter in the data set.

Description

The bindings allow a report item to pass data into its data set. For example, a report design may have a customer query from a personal database. For each customer, it wants to create a table of open orders from a sales database. The bindings allow the inner table item to pass values into the input parameters of the inner data set.

A data set parameter binding element that binds a data set input parameter to a BIRT expression. See the Binding Input Parameters section in this document for how a data set parameter binding is applied in relationship with report parameter binding.

See Also

Report Item bindings Property

Property Detail

expression Property

An expression used to compute the value of the parameter.

Details

Type: expression
Context:
Expression Type: any
Since: 1.0
Required: No
Display Name: Expression
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

Provides the value to bind to the input parameter. The expression executes in Factory context. The value of the expression must be legal for the associated input parameter, or a runtime error may occur. If the expression refers to a data row, the row is that of the outer report item (if any). No data row is available yet for this report item (because the data set has not yet been opened.)


paramName Property

The name of an input parameter in the data set.

Details

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

Description

This property identifies an input parameter within a data set or included report. The name must match a parameter defined in the data set or nested report.

The reference name of a data set input parameter and is required. Each data set parameter must have at most one binding expression defined within the paramBindings property of a data set.

See Also

Data Set parameters property

Include element (not in the first release)