Eclipse BIRT Report Object Model (ROM)
PropertyMask Structure
| Display Name: | Property Mask |
| Since: | 1.0 |
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.
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.
The action to take for the property.
| Type: | choice (propertyMaskType) |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Mask |
| JavaScript Type: | |
| Default Value: | hide |
| Runtime Settable: | Yes |
| Name | Display Name | Value | Description |
| change | Change | change | Allow the user to change the property. |
| lock | Lock | lock | Displays the property, but don’t allow changes. |
| hide | Hide | hide | Hides the property. (Default) |
The action to take for the property.
The name of a property.
| Type: | string |
| Since: | 1.0 |
| Required: | Yes |
| Display Name: | Name |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | Yes |
The name of the property to mask. The name must match an existing property.