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

(Global Index)

Syntax

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

Description

provides access to multiple properties with a single call.

Method Summary

getPropertySetInfo

setPropertyValues sets the values to the properties with the specified names.

getPropertyValues

addPropertiesChangeListener adds an XPropertiesChangeListener to the specified property with the specified names.

removePropertiesChangeListener removes an XPropertiesChangeListener from the listener list.

firePropertiesChangeEvent fires a sequence of PropertyChangeEvent s to the specified listener.

Method Details



getPropertySetInfo

Syntax

com::sun::star::beans::XPropertySetInfo getPropertySetInfo ();

Description

Returns

the XPropertySetInfo interface, which describes all properties of the object to which this interface belongs. NULL is returned if the object cannot or will not provide information about the properties.

See also

XPropertySet::getPropertySetInfo

setPropertyValues

Syntax

void setPropertyValues (
sequence< string > aPropertyNames,
sequence< any > aValues )
raises ( com::sun::star::beans::PropertyVetoException , com::sun::star::lang::IllegalArgumentException , com::sun::star::lang::WrappedTargetException );

Description

sets the values to the properties with the specified names.

The values of the properties must change before the bound events are fired. The values of the constrained properties should change after the vetoable events are fired and after if no exception occur Unknown properties are ignored.

Parameter aPropertyNames

specifies the names of the properties. All names must be unique. This sequence must be alphabetically sorted.

Parameter aValues

contains the new values of the properties. The order is the same as in aPropertyNames .

Throws

IllegalArgumentException if one of th enew values cannot be converted to the type of the unterlying property by an identity or widening conversion.

Throws

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

getPropertyValues

Syntax

sequence< any > getPropertyValues (
sequence< string > aPropertyNames );

Description

Returns

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

The order of the values in the returned sequence will be the same as the order of the names in the argument.

Parameter aPropertyNames

specifies the names of the properties. This sequence must be alphabetically sorted.

addPropertiesChangeListener

Syntax

oneway void addPropertiesChangeListener (
sequence< string > aPropertyNames,
com::sun::star::beans::XPropertiesChangeListener xListener );

Description

adds an XPropertiesChangeListener to the specified property with the specified names.

The implementation can ignore the names of the properties and fire the event on all properties.

Parameter aPropertyNames

specifies the names of the properties.

Parameter xListener

contains the listener for the property change events.

See also

removePropertiesChangeListener

removePropertiesChangeListener

Syntax

oneway void removePropertiesChangeListener (
com::sun::star::beans::XPropertiesChangeListener xListener );

Description

removes an XPropertiesChangeListener from the listener list.

It is a "noop" if the listener is not registered.

Parameter parameter ?

contains th elistener to be removed.

See also

addPropertiesChangeListener

firePropertiesChangeEvent

Syntax

oneway void firePropertiesChangeEvent (
sequence< string > aPropertyNames,
com::sun::star::beans::XPropertiesChangeListener xListener );

Description

fires a sequence of PropertyChangeEvent s to the specified listener.

Parameter aPropertynames

specifies the sorted names of the properties.

Parameter xListener

contains the listener for the property change events.
Top of Page