| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Dynamic Text 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">TextData Element</p> |
| <h1>Element Overview</h1> |
| <div class="section-text"> |
| Displays a multi-line block of text defined within the |
| report.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Dynamic Text</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>XML Element:</td> |
| <td><code>text-data</code></td></tr> |
| <tr><td>Extends:</td> |
| <td><a href="ReportItem.html">ReportItem</a></td></tr> |
| <tr><td>Extendable:</td> |
| <td>Yes</td></tr> |
| <tr><td>Abstract:</td> |
| <td>No</td></tr> |
| <tr><td>Name Space:</td> |
| <td>Report Items</td></tr> |
| <tr><td>Name Requirement:</td> |
| <td>Optional</td></tr> |
| <tr><td>Allows User Properties:</td> |
| <td>Yes</td></tr> |
| <tr><td>Has Style:</td> |
| <td>Yes</td></tr> |
| <tr><td>Default Style:</td> |
| <td><a href="../styles.html#text-data">text-data</a></td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-contentType">contentType</a></dt> |
| <dd>The formatting within the text: HTML / plain text</dd> |
| <dt><a href="#Property-valueExpr">valueExpr</a></dt> |
| <dd><span style="font-size:10.0pt;font-family:Arial; |
| mso-fareast-font-family:"Times New Roman";mso-bidi-font-family:"Times New Roman"; |
| mso-ansi-language:EN-US;mso-fareast-language:EN-US;mso-bidi-language:AR-SA">An |
| expression that provides the text</span></dd> |
| </dl> |
| |
| <h3>Method Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Method-onCreate">onCreate</a></dt> |
| <dd>Script executed when the element is created in the Factory.</dd> |
| <dt><a href="#Method-onPageBreak">onPageBreak</a></dt> |
| <dd></dd> |
| <dt><a href="#Method-onPrepare">onPrepare</a></dt> |
| <dd>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</dd> |
| <dt><a href="#Method-onRender">onRender</a></dt> |
| <dd>Script executed when the element is prepared for rendering in the Presentation engine.</dd> |
| </dl> |
| |
| <h3>Inherited Properties</h3> |
| |
| <p class="section-text"> |
| <a href="ReportItem.html#Property-bookmark">bookmark</a>, |
| <a href="ReportItem.html#Property-boundDataColumns">boundDataColumns</a>, |
| <a href="ReportElement.html#Property-comments">comments</a>, |
| <a href="ReportItem.html#Property-cube">cube</a>, |
| <a href="DesignElement.html#Property-customXml">customXml</a>, |
| <a href="ReportItem.html#Property-dataBindingRef">dataBindingRef</a>, |
| <a href="ReportItem.html#Property-dataSet">dataSet</a>, |
| <a href="ReportElement.html#Property-displayName">displayName</a>, |
| <a href="ReportElement.html#Property-displayNameID">displayNameID</a>, |
| <a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, |
| <a href="ReportElement.html#Property-extends">extends</a>, |
| <a href="ReportItem.html#Property-height">height</a>, |
| <a href="ReportElement.html#Property-name">name</a>, |
| <a href="ReportItem.html#Property-paramBindings">paramBindings</a>, |
| <a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, |
| <a href="ReportItem.html#Property-refTemplateParameter">refTemplateParameter</a>, |
| <a href="ReportItem.html#Property-style">style</a>, |
| <a href="ReportItem.html#Property-toc">toc</a>, |
| <a href="DesignElement.html#Property-userProperties">userProperties</a>, |
| <a href="ReportElement.html#Property-viewAction">viewAction</a>, |
| <a href="ReportItem.html#Property-visibility">visibility</a>, |
| <a href="ReportItem.html#Property-width">width</a>, |
| <a href="ReportItem.html#Property-x">x</a>, |
| <a href="ReportItem.html#Property-y">y</a>, |
| <a href="ReportItem.html#Property-zIndex">zIndex</a> |
| </p> |
| <h3>Style Properties</h3> |
| |
| <p class="section-text"> |
| <a href="Style.html#Property-backgroundAttachment">backgroundAttachment</a>, |
| <a href="Style.html#Property-backgroundColor">backgroundColor</a>, |
| <a href="Style.html#Property-backgroundImage">backgroundImage</a>, |
| <a href="Style.html#Property-backgroundPositionX">backgroundPositionX</a>, |
| <a href="Style.html#Property-backgroundPositionY">backgroundPositionY</a>, |
| <a href="Style.html#Property-backgroundRepeat">backgroundRepeat</a>, |
| <a href="Style.html#Property-borderBottomColor">borderBottomColor</a>, |
| <a href="Style.html#Property-borderBottomStyle">borderBottomStyle</a>, |
| <a href="Style.html#Property-borderBottomWidth">borderBottomWidth</a>, |
| <a href="Style.html#Property-borderLeftColor">borderLeftColor</a>, |
| <a href="Style.html#Property-borderLeftStyle">borderLeftStyle</a>, |
| <a href="Style.html#Property-borderLeftWidth">borderLeftWidth</a>, |
| <a href="Style.html#Property-borderRightColor">borderRightColor</a>, |
| <a href="Style.html#Property-borderRightStyle">borderRightStyle</a>, |
| <a href="Style.html#Property-borderRightWidth">borderRightWidth</a>, |
| <a href="Style.html#Property-borderTopColor">borderTopColor</a>, |
| <a href="Style.html#Property-borderTopStyle">borderTopStyle</a>, |
| <a href="Style.html#Property-borderTopWidth">borderTopWidth</a>, |
| <a href="Style.html#Property-canShrink">canShrink</a>, |
| <a href="Style.html#Property-color">color</a>, |
| <a href="Style.html#Property-display">display</a>, |
| <a href="Style.html#Property-fontFamily">fontFamily</a>, |
| <a href="Style.html#Property-fontSize">fontSize</a>, |
| <a href="Style.html#Property-fontStyle">fontStyle</a>, |
| <a href="Style.html#Property-fontVariant">fontVariant</a>, |
| <a href="Style.html#Property-fontWeight">fontWeight</a>, |
| <a href="Style.html#Property-highlightRules">highlightRules</a>, |
| <a href="Style.html#Property-letterSpacing">letterSpacing</a>, |
| <a href="Style.html#Property-lineHeight">lineHeight</a>, |
| <a href="Style.html#Property-marginBottom">marginBottom</a>, |
| <a href="Style.html#Property-marginLeft">marginLeft</a>, |
| <a href="Style.html#Property-marginRight">marginRight</a>, |
| <a href="Style.html#Property-marginTop">marginTop</a>, |
| <a href="Style.html#Property-masterPage">masterPage</a>, |
| <a href="Style.html#Property-orphans">orphans</a>, |
| <a href="Style.html#Property-paddingBottom">paddingBottom</a>, |
| <a href="Style.html#Property-paddingLeft">paddingLeft</a>, |
| <a href="Style.html#Property-paddingRight">paddingRight</a>, |
| <a href="Style.html#Property-paddingTop">paddingTop</a>, |
| <a href="Style.html#Property-pageBreakAfter">pageBreakAfter</a>, |
| <a href="Style.html#Property-pageBreakBefore">pageBreakBefore</a>, |
| <a href="Style.html#Property-pageBreakInside">pageBreakInside</a>, |
| <a href="Style.html#Property-showIfBlank">showIfBlank</a>, |
| <a href="Style.html#Property-textAlign">textAlign</a>, |
| <a href="Style.html#Property-textIndent">textIndent</a>, |
| <a href="Style.html#Property-textLineThrough">textLineThrough</a>, |
| <a href="Style.html#Property-textOverline">textOverline</a>, |
| <a href="Style.html#Property-textTransform">textTransform</a>, |
| <a href="Style.html#Property-textUnderline">textUnderline</a>, |
| <a href="Style.html#Property-verticalAlign">verticalAlign</a>, |
| <a href="Style.html#Property-whiteSpace">whiteSpace</a>, |
| <a href="Style.html#Property-widows">widows</a>, |
| <a href="Style.html#Property-wordSpacing">wordSpacing</a> |
| </p> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The text item allows the developer to provide the text as |
| part of the report design. The multi-line data item displays blocks of text |
| retrieved from the database, from a file, or from an expression. The text can be |
| plain text, HTML. The format of the text can be fixed at design time, or can be |
| dynamically selected at run time to match the format of the incoming text.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p>Text element</p> |
| <p> </p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-contentType">contentType Property</a></h2> |
| |
| <p class="section-text">The formatting within the text: HTML / plain text</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (textDataContentType)</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Content type</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</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> |
| |
| <h3>Choices</h3> |
| |
| <table class="section-table"> |
| <thead><tr><td>Name</td><td>Display Name</td> |
| <td>Value</td><td>Description</td></tr></thead> |
| <tbody> |
| <tr><td>auto</td> |
| <td>Auto</td> |
| <td>auto</td> |
| <td>BIRT will infer the |
| format as explained below.</td></tr> |
| <tr><td>plain</td> |
| <td>Plain</td> |
| <td>plain</td> |
| <td>Plain text with no |
| formatting.</td></tr> |
| <tr><td>html</td> |
| <td>HTML</td> |
| <td>html</td> |
| <td>Formatting using a |
| subset of HTML tags.</td></tr> |
| <tr><td>rtf</td> |
| <td>RTF</td> |
| <td>rtf</td> |
| <td></td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The user can explicitly identify the format of the text |
| using the Content Type property. Or, the user can set the property to "auto", |
| (or omit the property) and BIRT will infer the format from the text itself.</p> |
| |
| <p>BIRT determines the text format by examining the first |
| few characters of the string. If the first characters are "<HTML>" (in either |
| upper case or lower case), then the string is assumed to be HTML. Otherwise, the |
| text is plain text. Any white space before these characters is ignored. That is, |
| "<html>" and " <html>" are both taken to indicate that the text is formatted |
| in HTML.</p></div> |
| <h3>See Also</h3> |
| |
| <div class="section-text"> |
| <p> </p></div> |
| |
| <hr> |
| <h2><a name="Property-valueExpr">valueExpr Property</a></h2> |
| |
| <p class="section-text"><span style="font-size:10.0pt;font-family:Arial; |
| mso-fareast-font-family:"Times New Roman";mso-bidi-font-family:"Times New Roman"; |
| mso-ansi-language:EN-US;mso-fareast-language:EN-US;mso-bidi-language:AR-SA">An |
| expression that provides the text</span></p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#expression">expression</a></td></tr> |
| <tr><td>Context:</td> |
| <td></td></tr> |
| <tr><td>Expression Type:</td> |
| <td>string</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>Yes</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Value expression</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Inherited:</td> |
| <td>Yes</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> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The value expression provides the text to display. The expression is most |
| often simply a reference to a query column. But, it can also reference a report |
| parameter, a formula, a special value, a file, or other data item.</p></div> |
| <h1>Method Detail</h1> |
| |
| <h2><a name="Method-onCreate">onCreate Method</a></h2> |
| |
| <p class="section-text">Script executed when the element is created in the Factory.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.onCreate( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Context:</td> |
| <td>factory</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Executed when the element is created in the Factory. Called after the item is created, but before |
| the item is saved to the report document file. See the scripting spec for additional information |
| about this script. Applications should perform visual customization in the on-render script instead.</p></div> |
| |
| <hr> |
| <h2><a name="Method-onPageBreak">onPageBreak Method</a></h2> |
| |
| <p class="section-text"></p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.onPageBreak( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>2.1</td></tr> |
| <tr><td>Context:</td> |
| <td>presentation</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| |
| <hr> |
| <h2><a name="Method-onPrepare">onPrepare Method</a></h2> |
| |
| <p class="section-text">It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.onPrepare( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Context:</td> |
| <td>startup</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p></div> |
| |
| <hr> |
| <h2><a name="Method-onRender">onRender Method</a></h2> |
| |
| <p class="section-text">Script executed when the element is prepared for rendering in the Presentation engine.</p> |
| <h3>Synopsis |
| </h3> |
| |
| <p class="section-text"><code>None obj.onRender( )</code></p> |
| <h3>Details |
| </h3> |
| |
| <table class="detail-table"> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Context:</td> |
| <td>presentation</td></tr> |
| <tr><td>Arguments:</td> |
| <td>None</td></tr> |
| <tr><td>Return Type:</td> |
| <td>None</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Executed when the element is prepared for rendering in the Presentation engine. Changes made to the |
| element are written to the target output format, but not saved to the report document file. This is the |
| preferred place for visual customizations.</p></div> |
| </body> |
| </html> |
