Eclipse BIRT Report Object Model (ROM)
TemplateParameterDefinition Element
Display Name: | Template Parameter Definition |
Since: | 2.0 |
XML Element: | template-parameter-definition |
Extends: | None |
Extendable: | No |
Abstract: | No |
Name Space: | None |
Name Requirement: | Required |
Allows User Properties: | No |
Has Style: | No |
Represents a template parameter definition element. A template parameter definition gives a definition of a template element. It can be referred by one template report item or one template data set. The template parameter definition has the following properties:
Name of the element type that is allowed in the definition.
Type: | choice (templateElementType) |
Since: | 2.0 |
Required: | No |
Display Name: | Allowed type |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name | Display Name | Value | Description |
Table | Table | Table | |
FreeForm | FreeForm | FreeForm | |
Data | Data | Data | |
Grid | Grid | Grid | |
Image | Image | Image | |
Label | Label | Label | |
List | list | List | |
Text | Text | Text | |
ExtendedItem | ExtendedItem | ExtendedItem | |
TextData | TextData | TextData | |
DataSet | DataSet | DataSet |
Name of the property that defines the allowed element type of this TemplateParameterDefinition. It is enumeration of Table,Grid, Label, Text, ExtendedItem, other kind of report items and Dataset.
Description for this template definition.
Type: | string |
Since: | 2.0 |
Required: | No |
Display Name: | Description |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Externalizable text giving a description for this template definition
Resource key for the description text.
Type: | resourceKey |
Since: | 2.0 |
Required: | No |
Display Name: | Description ID |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Resource key for the externalizable description text.
Unique name of the template definition.
Type: | name |
Since: | 2.0 |
Required: | No |
Display Name: | Name |
JavaScript Type: | |
Default Value: | None |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Required and unique name for the template definition.
Slot that holds the default element of the TemplateParameterDefinition.
Display Name: | Default |
Since: | 2.0 |
XML Element: | default |
Contents: | Data, DataSet, ExtendedItem, FreeForm, Grid, Image, Label, Line, List, Table, Text, TextData |
The slot that holds the default element, the element will be used when a new element is created from the template.