LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XPropertyState Interface Referencepublished

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

import"XPropertyState.idl";

Inheritance diagram for XPropertyState:
XInterface PropertySet GroupAccess HierarchyAccess FormControlModel Paragraph TextCursor TextRange TextSection

Public Member Functions

com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([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 )
 
- Public Member Functions inherited from XInterface
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...
 

Detailed Description

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

The state contains the information if:

Developers Guide
ProUNO - Properties
Forms - Control Models

Member Function Documentation

any getPropertyDefault ( [in] string  aPropertyName)
raises ( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException
)
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.

Parameters
aPropertyNamespecifies the name of the property.
Exceptions
UnknownPropertyExceptionif the property does not exist.
com::sun::star::lang::WrappedTargetExceptionif 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
)
Returns
the state of the property.
Parameters
PropertyNamespecifies the name of the property.
Exceptions
UnknownPropertyExceptionif the property does not exist.
sequence<com::sun::star::beans::PropertyState> getPropertyStates ( [in] sequence< string >  aPropertyName)
raises (com::sun::star::beans::UnknownPropertyException
)
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.

Parameters
aPropertyNamecontains the sequence of property names.
Exceptions
UnknownPropertyExceptionif 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.

Parameters
PropertyNamespecifies the name of the property.
Exceptions
UnknownPropertyExceptionif the property does not exist.

The documentation for this interface was generated from the following file: