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

(Global Index)

Syntax

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

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

Method Summary

getHierarchicalPropertySetInfo retrieve information about the hierarchy of properties

setHierarchicalPropertyValue sets the value of the property with the specified nested name.

getHierarchicalPropertyValue

Method Details



getHierarchicalPropertySetInfo

Syntax

com::sun::star::beans::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

Syntax

void setHierarchicalPropertyValue (
string aHierarchicalPropertyName,
any aValue )
raises ( com::sun::star::beans::UnknownPropertyException , com::sun::star::beans::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::uno::lang::WrappedTargetException if the implementation has an internal reason for the exception. In this case the original exception is wrapped into that WrappedTargetException .

See also

XPropertySet::setPropertyValue

getHierarchicalPropertyValue

Syntax

any getHierarchicalPropertyValue (
string aHierarchicalPropertyName )
raises ( com::sun::star::beans::UnknownPropertyException , com::sun::star::lang::IllegalArgumentException , com::sun::star::lang::WrappedTargetException );

Description

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::uno::lang::WrappedTargetException if the implementation has an internal reason for the exception. In this case the original exception is wrapped into that WrappedTargetException .

See also

XPropertySet::getPropertyValue
Top of Page