interface XPropertyState in module com::sun::star::beans::

(Global Index)

Syntax

interface XPropertyState : com::sun::star::uno::XInterface ;

Description

makes it possible to query information about the state of one or more properties.

The state contains the information if:

Method Summary

getPropertyState

getPropertyStates

setPropertyToDefault Sets the property to default value.

getPropertyDefault

Method Details



getPropertyState

Syntax

com::sun::star::beans::PropertyState getPropertyState (
string PropertyName )
raises ( com::sun::star::beans::UnknownPropertyException );

Description

Returns

the state of the property.

Parameter aPropertyName

specifies the name of the property.

Throws

UnknownPropertyException if the property does not exist.

getPropertyStates

Syntax

sequence< com::sun::star::beans::PropertyState > getPropertyStates (
sequence< string > aPropertyName )
raises ( com::sun::star::beans::UnknownPropertyException );

Description

Returns

a sequence of the states of the properties which are specified by their names.

The order of the states is correlating to the order of the given property names.

Parameter aPropertyNames

contains te sequence of property names.

Throws

UnknownPropertyException if one property does not exist.

setPropertyToDefault

Syntax

void setPropertyToDefault (
string PropertyName )
raises ( com::sun::star::beans::UnknownPropertyException );

Description

Sets the property to default value.

The value depends on the implementation of this interface. If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you must fire the vetoable event before you change the property value.

Parameter aPropertyname

specifies the name of the property.

Throws

UnknownPropertyException if the property does not exist.

getPropertyDefault

Syntax

any getPropertyDefault (
string aPropertyName )
raises ( com::sun::star::beans::UnknownPropertyException , com::sun::star::lang::WrappedTargetException );

Description

Returns

the default value of the property with the name PropertyName.

If no default exists, is not known or is void, then the return type is void .

Parameter aPropertyName

specifies the name of the property.

Throws

UnknownPropertyException if the property does not exist.

Throws

com::sun::star::lang::WrappedTargetException if the implementation has an internal reason for the exception. In this case the original exception is wrapped into that WrappedTargetException .
Top of Page