| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Property Mask 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">PropertyMask Structure</p> |
| <h1>Structure Overview</h1> |
| <div class="section-text"> |
| Allows a third-party developer to lock or hide a |
| property.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Property Mask</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-mask">mask</a></dt> |
| <dd>The action to take for the property.</dd> |
| <dt><a href="#Property-name">name</a></dt> |
| <dd>The name of a property.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>A property mask says how to hide or lock a property. |
| Applies to any kind of property: ROM-defined, user-defined, or |
| extension-defined. The mask is used when creating a reusable component, it |
| allows the developer to hide properties that the consumer does not need or |
| should not change.</p> |
| <p>The mask is not meant to be a security rule; it is |
| instead designed to help a component designer customize the property sheet UI. |
| Because of this, a mask on a derived element can hide a mask on a base element: |
| element A can lock a property. Element B can derive from A and unlock the |
| property.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-mask">mask Property</a></h2> |
| |
| <p class="section-text">The action to take for the property.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (propertyMaskType)</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>Mask</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>hide</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>change</td> |
| <td>Change</td> |
| <td>change</td> |
| <td>Allow the user to |
| change the property.</td></tr> |
| <tr><td>lock</td> |
| <td>Lock</td> |
| <td>lock</td> |
| <td>Displays the property, |
| but don�t allow changes.</td></tr> |
| <tr><td>hide</td> |
| <td>Hide</td> |
| <td>hide</td> |
| <td>Hides the property. |
| (Default)</td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The action to take for the property.</p></p></div> |
| |
| <hr> |
| <h2><a name="Property-name">name Property</a></h2> |
| |
| <p class="section-text">The name of a property.</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>Yes</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>Runtime Settable:</td> |
| <td>Yes</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>The name of the property to mask. The name must match an |
| existing property.</p></p></div> |
| </body> |
| </html> |
