| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Template Element Element (Eclipse BIRT ROM Documentation)</title> |
| <link rel="stylesheet" href="../style/style.css" type="text/css"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </head> |
| <body> |
| <p class="title">Eclipse BIRT Report Object Model (ROM)</p> |
| <p class="subtitle">TemplateElement Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| A base template element, represents placeholder for a data set or a report item.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Template Element</td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>None</code></td></tr> |
| <tr><td>Extends:</td> |
| <td>None</td></tr> |
| <tr><td>Extendable:</td> |
| <td>No</td></tr> |
| <tr><td>Abstract:</td> |
| <td>Yes</td></tr> |
| <tr><td>Name Space:</td> |
| <td>None</td></tr> |
| <tr><td>Name Requirement:</td> |
| <td>Not Supported</td></tr> |
| <tr><td>Allows User Properties:</td> |
| <td>No</td></tr> |
| <tr><td>Has Style:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-displayName">displayName</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-displayNameID">displayNameID</a></dt> |
| <dd></dd> |
| <dt><a href="#Property-name">name</a></dt> |
| <dd>name of the template element</dd> |
| <dt><a href="#Property-refTemplateParameter">refTemplateParameter</a></dt> |
| <dd>Reference to the template element definition.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>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.</div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-displayName">displayName Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#string">string</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Display Name</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>No</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| |
| <hr> |
| <h2><a name="Property-displayNameID">displayNameID Property</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#resourceKey">resourceKey</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.1</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Display Name ID</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>No</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| |
| <hr> |
| <h2><a name="Property-name">name Property</a></h2> |
| |
| <p class="section-text">name of the template element</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#name">name</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Name</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>No</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Visible</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Name of the template element.</p></div> |
| |
| <hr> |
| <h2><a name="Property-refTemplateParameter">refTemplateParameter Property</a></h2> |
| |
| <p class="section-text">Reference to the template element definition.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../elements/TemplateParameterDefinition.html">TemplateParameterDefinition</a> Reference</td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Ref Template Parameter</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>No</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| <tr><td>Property Sheet Visibility:</td> |
| <td>Hidden</td></tr> |
| <tr><td>Property Sheet Group:</td> |
| <td>Top</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Reference to the template element definition.</p></div> |
| </body> |
| </html> |
