Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: beans ::

enum PropertyState
Description
This enumeration lists the states that a property value can have.

The state consists of two aspects:

  1. whether a value is available or void,
  2. whether the value is stored in the property set itself or is a default, or ambiguous.
See also
XPropertyState, Property

Values
DIRECT_VALUE The value of the property is stored in the PropertySet itself.  
DEFAULT_VALUE The value of the property is available from a master (e.g., template).  
AMBIGUOUS_VALUE The value of the property is only a recommendation because there are multiple values for this property (e.g., from a multi selection).  
Values' Details
DIRECT_VALUE
DIRECT_VALUE,
Description
The value of the property is stored in the PropertySet itself.

The property value must be available and of the specified type. If the PropertyAttribute field in the struct Property contains PropertyAttribute::MAYBEVOID, then the value may be void.

DEFAULT_VALUE
DEFAULT_VALUE,
Description
The value of the property is available from a master (e.g., template).

The PropertyAttribute field in the struct Property must contain the PropertyAttribute::MAYBEDEFAULT flag. The property value must be available and of the specified type. If the PropertyAttribute field in the struct Property contains PropertyAttribute::MAYBEVOID, then the value may be void.

AMBIGUOUS_VALUE
AMBIGUOUS_VALUE,
Description
The value of the property is only a recommendation because there are multiple values for this property (e.g., from a multi selection).

The PropertyAttribute field in the struct Property must contain the PropertyAttribute::MAYBEAMBIGUOUS flag. The property value must be available and of the specified type. If the Attribute field in the struct Property contains PropertyAttribute::MAYBEVOID, then the value may be void.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.