Eclipse BIRT Report Object Model (ROM)

PropertyMask Structure

Structure Overview

Allows a third-party developer to lock or hide a property.

Details

Display Name: Property Mask
Since: 1.0

Property Summary

mask
The action to take for the property.
name
The name of a property.

Description

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.

Property Detail

mask Property

The action to take for the property.

Details

Type: choice (propertyMaskType)
Since: 1.0
Required: No
Display Name: Mask
JavaScript Type:
Default Value: hide
Runtime Settable: Yes

Choices

NameDisplay Name ValueDescription
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)

Description

The action to take for the property.


name Property

The name of a property.

Details

Type: string
Since: 1.0
Required: Yes
Display Name: Name
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

The name of the property to mask. The name must match an existing property.