Eclipse BIRT Report Object Model (ROM)

VariableElement Element

# Element Overview

Represents a report/page variable in the report.

### Details

Display Name: | Variable
Since: | 2.3
XML Element: | `None`
Extends: | None
Extendable: | No
Abstract: | Yes
Name Space: | None
Name Requirement: | Required
Allows User Properties: | No
Has Style: | No

### Property Summary

name
  The name for the variable.
type
  The type for the variable.
value
  The value for the variable.

### Description

The variable can be defined in the report. There are two types of variable: report variable and page variable. Report variable means the variable is finalized at the end of report. Page variable means the variable is finalized for each page. The variable can be used in onPageStart/onPageEnd scripts.

# Property Detail

## name Property

The name for the variable.

### Details

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

## type Property

The type for the variable.

### Details

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

### Choices

Name | Display Name | Value | Description
report | Report Variable | report | the report variable.
page | Page Variable | page | the master page variable.

## value Property

The value for the variable.

### Details

Type: | expression
Context: |
Expression Type: | None
Since: | 2.3
Required: | No
Display Name: | Value
JavaScript Type: |
Default Value: | None
Inherited: | Yes
Runtime Settable: | Yes
Property Sheet Visibility: | Visible
Property Sheet Group: | Top