LibreOffice
LibreOffice 5.1 SDK API Reference
|
makes it possible to query information about the state of one or more properties. More...
import"XPropertyState.idl";
Public Member Functions | |
com::sun::star::beans::PropertyState | getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
sequence< com::sun::star::beans::PropertyState > | getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
void | setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
Sets the property to default value. More... | |
any | getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
![]() | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. More... | |
void | acquire () |
increases the reference counter by one. More... | |
void | release () |
decreases the reference counter by one. More... | |
makes it possible to query information about the state of one or more properties.
The state contains the information if:
any getPropertyDefault | ( | [in] string | aPropertyName | ) | |
raises | ( | com::sun::star::beans::UnknownPropertyException, | |||
com::sun::star::lang::WrappedTargetException | |||||
) |
If no default exists, is not known or is void, then the return type is void
.
aPropertyName | specifies the name of the property. |
UnknownPropertyException | if the property does not exist. |
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 com::sun::star::lang::WrappedTargetException. |
com::sun::star::beans::PropertyState getPropertyState | ( | [in] string | PropertyName | ) | |
raises | ( | com::sun::star::beans::UnknownPropertyException | |||
) |
PropertyName | specifies the name of the property. |
UnknownPropertyException | if the property does not exist. |
sequence<com::sun::star::beans::PropertyState> getPropertyStates | ( | [in] sequence< string > | aPropertyName | ) | |
raises | ( | com::sun::star::beans::UnknownPropertyException | |||
) |
The order of the states is correlating to the order of the given property names.
aPropertyName | contains the sequence of property names. |
UnknownPropertyException | if one property does not exist. |
void setPropertyToDefault | ( | [in] string | PropertyName | ) | |
raises | ( | com::sun::star::beans::UnknownPropertyException | |||
) |
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.
PropertyName | specifies the name of the property. |
UnknownPropertyException | if the property does not exist. |