Eclipse BIRT Report Object Model (ROM)

TemplateElement Element

# Element Overview

A base template element, represents placeholder for a data set or a report item.

### Details

Display Name: | Template Element
Since: | 2.0
XML Element: | `None`
Extends: | None
Extendable: | No
Abstract: | Yes
Name Space: | None
Name Requirement: | Optional
Allows User Properties: | No
Has Style: | No

### Property Summary

displayName
displayNameID
name
  name of the template element
refTemplateParameter
  Reference to the template element definition.

### Description

The base class for template elements. A template element is a place holder for a real report item or data set element. Application can create a template element for an existing data set or a report item, and later transform it to the real element/data set, do some required modifications and add it to a report.

# Property Detail

## displayName Property

### Details

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

## displayNameID Property

### Details

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

## name Property

name of the template element

### 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

Name of the template element.

## refTemplateParameter Property

Reference to the template element definition.

### Details

Type: | TemplateParameterDefinition Reference
Since: | 2.0
Required: | No
Display Name: | Reference template parameter
JavaScript Type: |
Default Value: | None
Inherited: | No
Runtime Settable: | No
Property Sheet Visibility: | Hidden
Property Sheet Group: | Top

### Description

Reference to the template element definition.