interface XFunctionAccess in module com::sun::star::sheet::

(Global Index)

Syntax

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

Description

allows generic access to all spreadsheet functions.

Method Summary

callFunction calls a function and returns the result of the call.

Known Services Which Export this Interface

com::sun::star::sheet::FunctionAccess

Method Details



callFunction

Syntax

any callFunction (
string aName,
sequence< any > aArguments )
raises ( com::sun::star::container::NoSuchElementException , com::sun::star::lang::IllegalArgumentException );

Description

calls a function and returns the result of the call.

Parameter aName

the (programmatic) name of the function.

Parameter aArguments

the arguments for the function call.

Each element must be of one of the following types:

long or double
for a numeric value.
string
for a textual value.
> long[][] or > double[][]
for an array of numeric values.
string[][]
for an array of textual values.
any[][]
for a mixed array, where each element must be of void , long , double or string type.
XCellRange
for a SheetCellRange object that contains the data.

Returns

the result of the function call.

Possible types for the result are:

void
if no result is available.
double
for a numeric result.
string
for a textual result.
any[][]
for an array result, containing double and string values.

Throws

NoSuchElementException if the named function does not exist.

Throws

IllegalArgumentException if the function can not be called with these arguments.
Top of Page