ooodev.adapter.sheet.function_access_partial module

class ooodev.adapter.sheet.function_access_partial.FunctionAccessPartial(component, interface=com.sun.star.sheet.XFunctionAccess)[source]

Bases: object

Partial Class for XFunctionAccess.

New in version 0.34.4.

Parameters:

  • component (XFunctionAccess) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.sheet.XFunctionAccess)[source]

Constructor

Parameters:

  • component (XFunctionAccess) – UNO Component that implements com.sun.star.sheet.XFunctionAccess.

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

Return type:

None

call_function(name, *args)[source]

Calls a function and returns the result of the call.

Each element must be of one of the following types:

Possible types for the result are:

  • int or float for a numeric value.

  • str for a string value.

  • Tuple[Tuple[int,...], ...] or Tuple[Tuple[float, ...], ...] for an array of numeric values.

  • Tuple[[str, ...], ...] for an array of string values.

  • Tuple[[Any, ...], ...] for a mixed array, where each element must be of None, int, float or str type.

Raises:

  • com.sun.star.container.NoSuchElementException – NoSuchElementException

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

Returns:

the result of the function call.

Return type:

Any

Parameters:

  • name (str) –

  • args (Any) –

Note

Possible types for the result are:

  • None if no result is available.

  • float for a numeric result.

  • str for a string result.

  • Tuple[[Any, …], …] for an array result, containing float and str values.