(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

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

interface XFunctionAccess
Description
allows generic access to all spreadsheet functions.
See also
FunctionAccess

Methods' Summary
callFunction calls a function and returns the result of the call.  
Methods' Details
callFunction
any
callFunction( [in] string  aName,
[in] 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.
::com::sun::star::table::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
::com::sun::star::container::NoSuchElementException if the named function does not exist.
Throws
::com::sun::star::lang::IllegalArgumentException if the function can not be called with these arguments.
Top of Page

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.