ooodev.adapter.beans.hierarchical_property_set_partial module

class ooodev.adapter.beans.hierarchical_property_set_partial.HierarchicalPropertySetPartial(component, interface=com.sun.star.beans.XHierarchicalPropertySet)[source]

Bases: object

Partial class for XHierarchicalPropertySet.

Parameters:

  • component (XHierarchicalPropertySet) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.beans.XHierarchicalPropertySet)[source]

Constructor

Parameters:

  • component (XHierarchicalPropertySet) – UNO Component that implements com.sun.star.bean.XHierarchicalPropertySet interface.

  • interface (UnoInterface, optional) – The interface to be validated. Defaults to XHierarchicalPropertySet.

Return type:

None

get_hierarchical_property_set_info()[source]

Gets information about the hierarchy of properties.

Return type:

XHierarchicalPropertySetInfo

get_hierarchical_property_value(name)[source]

Gets the value of the property with the specified name.

Parameters:

name (str) – The Hierarchical Property Name of the property.

Raises:

  • com.sun.star.beans.UnknownPropertyException – UnknownPropertyException

  • com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

  • com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

Any

set_hierarchical_property_value(name, value)[source]

Sets the value of the property with the specified nested name.

Parameters:

  • name (str) – The Hierarchical Property Name of the property.

  • value (Any) – The value to be set.

Raises:

  • com.sun.star.beans.UnknownPropertyException – UnknownPropertyException

  • com.sun.star.beans.PropertyVetoException – PropertyVetoException

  • com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

  • com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

None

ooodev.adapter.beans.hierarchical_property_set_partial.get_builder(component)[source]

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder