Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: beans ::
interface XMultiHierarchicalPropertySet
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XMultiHierarchicalPropertySet
Description provides access to multiple properties which form a hierarchy. See also XHierarchicalPropertySet

Methods' Summary
getHierarchicalPropertySetInfo | retrieve information about the hierarchy of properties
setHierarchicalPropertyValues | sets the values of the properties with the specified nested names.
getHierarchicalPropertyValues |

Methods' Details
getHierarchicalPropertySetInfo
XHierarchicalPropertySetInfo getHierarchicalPropertySetInfo(); |  |
Description retrieve information about the hierarchy of properties Returns the XHierarchicalPropertySetInfo interface, which describes the property hierarchy of the object which supplies this interface. Returns NULL if the implementation cannot or will not provide information about the properties; otherwise the interface XHierarchicalPropertySetInfo is returned. See also XHierarchicalPropertySet::getHierarchicalPropertySetInfo
setHierarchicalPropertyValues
void setHierarchicalPropertyValues( | [in] sequence< string > [in] sequence< any > raises( | aHierarchicalPropertyNames, Values ) PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException );
Description sets the values of the properties with the specified nested names. The values of the properties must change before bound events are fired. The values of constrained properties should change after the vetoable events are fired, if no exception occurs. Unknown properties are ignored. Parameter aHierarchicalPropertyNames This parameter specifies the names of the properties. Parameter aValues This parameter specifies the new values for the properties. Throws PropertyVetoException if one of the properties is constrained and the change is vetoed by a XVetoableChangeListener . Throws com::sun::star::lang::IllegalArgumentException if one of the values is not a legal value for the corresponding property or if one of the names is not a well-formed nested name for this hierarchy. An implementation is not required to detect the latter condition. 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 ::com::sun::star::lang::WrappedTargetException . See also XHierarchicalPropertySet::setHierarchicalPropertyValue See also XMultiPropertySet::setPropertyValues
getHierarchicalPropertyValues
sequence< any > getHierarchicalPropertyValues( | [in] sequence< string > raises( | aPropertyNames ) ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException );
Returns a sequence of all values of the properties which are specified by their nested names. The order of the values in the returned sequence will be the same as the order of the names in the argument. Unknown properties are ignored, in their place NULL will be returned. Throws com::sun::star::lang::IllegalArgumentException if one of the names is not a well-formed nested name for this hierarchy. An implementation is not required to detect this condition. 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 ::com::sun::star::lang::WrappedTargetException . See also XHierarchicalPropertySet::getHierarchicalPropertyValue See also XMultiPropertySet::setPropertyValues

Top of Page

Copyright © 2003 Sun Microsystems, Inc.