Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: beans ::
interface XHierarchicalPropertySet
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XHierarchicalPropertySet
Description provides information about and access to the a hierarchy of properties from an implementation. Usually an object that implements this interface also implements XPropertySet and at least some of the properties have subproperties. This interface allows direct access to subsubproperties, ... up to an arbitrary nesting depth. Often the intermediate elements of the hierarchy implement XProperty . Each implementation specifies how the hierarchical property names, that are used to access the elements of the hierarchy, are formed. Commonly a notation similar to filesystem pathes (separated by '/' slashes) or nested module names (separated by dots '.' or '::') is used.

Methods' Summary
getHierarchicalPropertySetInfo | retrieve information about the hierarchy of properties
setHierarchicalPropertyValue | sets the value of the property with the specified nested name.
getHierarchicalPropertyValue |

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.
setHierarchicalPropertyValue
void setHierarchicalPropertyValue( | [in] string [in] any raises( | aHierarchicalPropertyName, aValue ) UnknownPropertyException, PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException );
Description sets the value of the property with the specified nested name. Parameter aHierarchicalPropertyName This parameter specifies the name of the property. Parameter aValue This parameter specifies the new value for the property. Throws UnknownPropertyException if the property does not exist. Throws PropertyVetoException if the property is constrained and the change is vetoed by a XVetoableChangeListener . Throws com::sun::star::uno::lang::IllegalArgumentException if aValue is not a legal value for this property or if aHierarchicalPropertyName 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 XPropertySet::setPropertyValue
getHierarchicalPropertyValue
any getHierarchicalPropertyValue( | [in] string raises( | aHierarchicalPropertyName ) UnknownPropertyException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException );
Returns the value of the property with the specified nested name. Parameter aHierarchicalPropertyName This parameter specifies the name of the property. Throws UnknownPropertyException if the property does not exist. Throws com::sun::star::uno::lang::IllegalArgumentException if aHierarchicalPropertyName 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 XPropertySet::getPropertyValue

Top of Page

Copyright © 2003 Sun Microsystems, Inc.