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

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

interface XMultiPropertyStates

Base Interface
com::sun::star::uno::XInterface

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

The state of a property contains information about the source of the value, e.g. the object itself, a default or a stylesheet. For more information see PropertyState .



Known Services which Export this Interface

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::style::Style This service specifies a single style sheet.
com::sun::star::text::TextCursor A TextCursor is a TextRange which can be moved within a Text object.

Methods' Summary

getPropertyStates
setAllPropertiesToDefault sets all properties to their default values.
setPropertiesToDefault sets the specified properties to their default values.
getPropertyDefaults

Methods' Details

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 aPropertyName
specifies the names of the properties. All names must be unique. This sequence must be alphabetically sorted.
setAllPropertiesToDefault
 
void
setAllPropertiesToDefault();
Description
sets all properties to their default values.

Each 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.

setPropertiesToDefault
 
void
setPropertiesToDefault(
[ in ] sequence< string > aPropertyNames )
raises ( com::sun::star::beans::UnknownPropertyException );

Description
sets the specified properties to their default values.

Each 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 names of the properties. All names must be unique. This sequence must be alphabetically sorted.
Throws
UnknownPropertyException if one of the properties does not exist.
getPropertyDefaults
 
sequence< any >
getPropertyDefaults(
[ in ] sequence< string > aPropertyNames )
raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException );

Returns
the default values of the propertes with the specified names.

If no default exists, is not known, or is void, then the return type at the corresponding position in the sequence returned is void .

Parameter aPropertyName
specifies the names of the properties. All names must be unique. This sequence must be alphabetically sorted.
Throws
UnknownPropertyException if one of the propertes 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