| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Hide 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">HideRule Structure</p> |
| <h1>Structure Overview</h1> |
| <div class="section-text"> |
| Defines a visibility rule for a report item in a kind of output format.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Hide</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-format">format</a></dt> |
| <dd>Identifies the format in which the element should be hidden.</dd> |
| <dt><a href="#Property-valueExpr">valueExpr</a></dt> |
| <dd>A boolean expression that determines whether to hide the element or not.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The visibility rule says when a report item should be hidden. It can be hidden based |
| on the output type, an expression, or both. For example, the browser control is normally |
| hidden in all output formats except HTML. A past-due item might be hidden if the account |
| is not past due.</p> |
| |
| <p>An item can be completely hidden (hidden in all formats), or hidden only in selected |
| formats. An item hidden in all formats is never actually created in the Factory. An item |
| hidden in selected formats is created, but will be omitted when rendered to the format |
| for which it is hidden.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-format">format Property</a></h2> |
| |
| <p class="section-text">Identifies the format in which the element should be hidden.</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>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Format</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>all</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</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>all</td> |
| <td>All</td> |
| <td>all</td> |
| <td></td></tr> |
| <tr><td>viewer</td> |
| <td>Viewer</td> |
| <td>viewer</td> |
| <td></td></tr> |
| <tr><td>pdf</td> |
| <td>Pdf</td> |
| <td>pdf</td> |
| <td></td></tr> |
| <tr><td>reportlet</td> |
| <td>Reportlet</td> |
| <td>reportlet</td> |
| <td></td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>This property identifies the output format in which to hide the element. The element can be |
| hidden in all output formats (using the "All" choice), or in a specific format. If the element |
| is hidden in all formats, then it is not created in the Factory. Otherwise, is created, but is |
| removed before rendering in the Presentation engine when converted to the target output format.</p></div> |
| |
| <hr> |
| <h2><a name="Property-valueExpr">valueExpr Property</a></h2> |
| |
| <p class="section-text">A boolean expression that determines whether to hide the element or not.</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>boolean</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>Expression</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The boolean expression to evaluate. If the expression evaluates to <code>true</code>, then the element is |
| hidden; Otherwise, the element is not hidden. Default to <code>true</code> if no expression is given.</p></div> |
| </body> |
| </html> |
