Eclipse BIRT Report Object Model (ROM)

TemplateParameterDefinition Element

# Element Overview

Represents a definition for a template element.

### Details

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

### Property Summary

allowedType
  Name of the element type that is allowed in the definition.
description
  Description for this template definition.
descriptionID
  Resource key for the description text.
name
  Unique name of the template definition.

### Slot Summary

default
  Slot that holds the default element of the TemplateParameterDefinition.

### Description

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:

- A required and unique name for this template parameter definition.
- A type for this template parameter definition. It is a the enumeration of Table,Grid, Label, Text, ExtendedItem or other kind of report items and Dataset.
- A static description message that will be show to the client user.

# Property Detail

## allowedType Property

Name of the element type that is allowed in the definition.

### Details

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

### Choices

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 |

### Description

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 Property

Description for this template definition.

### Details

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

### Description

Externalizable text giving a description for this template definition

## descriptionID Property

Resource key for the description text.

### Details

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

### Description

Resource key for the externalizable description text.

## name Property

Unique name of the template definition.

### Details

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

### Description

Required and unique name for the template definition.

# Slot Detail

## default Slot

Slot that holds the default element of the TemplateParameterDefinition.

### Details

Display Name: | Default
Since: | 2.0
XML Element: | `default`
Contents: | Data, DataSet, ExtendedItem, FreeForm, Grid, Image, Label, Line, List, Table, Text, TextData

### Description

The slot that holds the default element, the element will be used when a new element is created from the template.