Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XPropertyState

Base Interface
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:



Known Services which Export this Interface

com::sun::star::beans::PropertySet specifies an abstract service which gives some hints which interfaces belong to a proper property set implementation.
com::sun::star::beans::PropertySet specifies an abstract service which gives some hints which interfaces belong to a proper property set implementation.
com::sun::star::form::FormControlModel specifies a control model within a form.
com::sun::star::configuration::GroupAccess provides access to a predefined heterogeneous group of values and nested trees as part of a (by name) hierarchy.
com::sun::star::text::TextSection A TextSection is a range of complete paragraphs within a text. @
com::sun::star::text::Paragraph is a piece of text which can take its own paragraph-specific attributes (technically, properties).
com::sun::star::text::TextCursor A TextCursor is a TextRange which can be moved within a Text object.
com::sun::star::text::TextRange points to a sequence of characters within a Text .

Methods' Summary

getPropertyState
getPropertyStates
setPropertyToDefault Sets the property to default value.
getPropertyDefault

Methods' Details

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

Returns
the state of the property.
Parameter aPropertyName
specifies the name of the property.
Throws
UnknownPropertyException if the property does not exist.
getPropertyStates
 
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.

Parameter aPropertyNames
contains the sequence of property names.
Throws
UnknownPropertyException if one property does not exist.
setPropertyToDefault
 
void
setPropertyToDefault(
[ in ] 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
 
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 .

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