Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished interface XMultiFormulaTokens
Usage Restrictions
not published
Description
gives access to multiple sets of formula tokens. A service implementing this interface can internally set an arbitrary number of formula token sequences. The number of allowed formula token sequences must be returned by the XMultiFormulaTokens::getCount method. When the client code tries to access formula tokens at index that is outside the allowed index range, the implementation shall return an IndexOutOfBoundsException.

Methods' Summary
getTokens returns the formula at specified index as sequence of tokens.  
setTokens sets the formula at specified index as sequence of tokens.  
getCount returns the number of formulas allowed in this formula token set.  
Methods' Details
getTokens
sequence< FormulaToken >
getTokens( [in] long  nIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
returns the formula at specified index as sequence of tokens.
Throws
IndexOutOfBoundsException If the given index lies not in the valid range then an ::com::sun::star::lang::IndexOutOfBoundsException exception is thrown.
setTokens
void
setTokens( [in] long  nIndex,
[in] sequence< FormulaToken >  aTokens )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
sets the formula at specified index as sequence of tokens.
Throws
IndexOutOfBoundsException If the given index lies not in the valid range then an ::com::sun::star::lang::IndexOutOfBoundsException exception is thrown.
getCount
long
getCount();

Description
returns the number of formulas allowed in this formula token set.
Returns
the number of formulas the implementation supports.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.