ooodev.adapter.util.property_replace_partial module

class ooodev.adapter.util.property_replace_partial.PropertyReplacePartial(component, interface=com.sun.star.util.XPropertyReplace)

Bases: ReplaceDescriptorPartial

Partial class for XPropertyReplace.

Parameters:

• component (XPropertyReplace) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.util.XPropertyReplace)

Constructor

Parameters:

• component (XPropertyReplace) – UNO Component that implements com.sun.star.util.XPropertyReplace interface.

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

Return type:

None

get_replace_attributes()

Gets the properties to replace the found occurrences.

Return type:

Tuple[PropertyValue, ...]

get_search_attributes()

Get the search attributes.

Return type:

Tuple[PropertyValue, ...]

get_value_search()

provides the information if specific property values are searched, or just the existence of the specified properties.

Return type:

bool

set_replace_attributes(*attribs)

Sets the properties to replace the found occurrences.

Raises:

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

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

Return type:

None

Parameters:

attribs (PropertyValue) –

set_search_attributes(*attribs)

Sets the properties to search for.

Raises:

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

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

Return type:

None

Parameters:

attribs (PropertyValue) –

set_value_search(value_search)

Sets if specific property values are searched, or just the existence of the specified properties.

Return type:

None

Parameters:

value_search (bool) –