enum PropertyState in module com::sun::star::beans::

(Global Index)

Syntax

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

See also

Property

Values Summary

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

Syntax

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

Syntax

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

Syntax

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