Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XMultiPropertySet
Description
provides access to multiple properties with a single call.
Developers Guide
ProUNO - Properties

Methods' 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 PropertyChangeEvents to the specified listener.  
Methods' Details
getPropertySetInfo
XPropertySetInfo
getPropertySetInfo();

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
void
setPropertyValues( [in] sequence< string >  aPropertyNames,
[in] sequence< any >  aValues )
raises( 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 only if no exception occured. 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 the new values cannot be converted to the type of the underlying 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
sequence< any >
getPropertyValues( [in] sequence< string >  aPropertyNames );

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
[oneway] void
addPropertiesChangeListener( [in] sequence< string >  aPropertyNames,
[in] 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.

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

Parameter aPropertyNames
specifies the names of the properties.
Parameter xListener
contains the listener for the property change events.
See also
removePropertiesChangeListener
removePropertiesChangeListener
[oneway] void
removePropertiesChangeListener( [in] XPropertiesChangeListener  xListener );

Description
removes an XPropertiesChangeListener from the listener list.

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

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

Parameter contains
the listener to be removed.
See also
addPropertiesChangeListener
firePropertiesChangeEvent
[oneway] void
firePropertiesChangeEvent( [in] sequence< string >  aPropertyNames,
[in] XPropertiesChangeListener  xListener );

Description
fires a sequence of PropertyChangeEvents 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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.