Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished interface XExternalSheetCache
Usage Restrictions
not published
Description
Primary interface for the ExternalSheetCache service.
Since
OOo 3.1
See also
ExternalSheetCache

Methods' Summary
setCellValue It sets a cached value for a specified cell position. The value is expected to be either of type ::string or of type ::double. No other data types are supported.  
getCellValue It retrieves a cached value from a specified cell position. The cached value can be either ::string or ::double.  
getAllRows It returns a list of all row numbers where a cached cell or cells exist. The row numbers are sorted in ascending order.  
getAllColumns Given a row number, this method returns a list of all columns numbers that store cached cell values in that row. The column numbers are sorted in ascending order.  
Attributes' Summary
TokenIndex Index corresponding to this instance of an external sheet cache for usage in formula tokens.  
Methods' Details
setCellValue
void
setCellValue( [in] long  nColumn,
[in] long  nRow,
[in] any  aValue )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
It sets a cached value for a specified cell position. The value is expected to be either of type ::string or of type ::double. No other data types are supported.
Parameter nRow
row position (0-based)
Parameter nColumn
column position (0-based)
Parameter aValue
cell value to be cached
getCellValue
any
getCellValue( [in] long  nColumn,
[in] long  nRow )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
It retrieves a cached value from a specified cell position. The cached value can be either ::string or ::double.
Returns
any cached cell value
getAllRows
sequence< long >
getAllRows();

Description
It returns a list of all row numbers where a cached cell or cells exist. The row numbers are sorted in ascending order.
Returns
sequence list of all row numbers with cached cell(s)
getAllColumns
sequence< long >
getAllColumns( [in] long  nRow )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Given a row number, this method returns a list of all columns numbers that store cached cell values in that row. The column numbers are sorted in ascending order.
Returns
sequence list of all columns numbers with cached cell values
Attributes' Details
TokenIndex
[ readonly ] long TokenIndex;
Description
Index corresponding to this instance of an external sheet cache for usage in formula tokens.

This index to the external sheet cache is expected in the SingleReference::Sheet member if it is part of an external reference token.

Each external sheet cache has a unique index value inside the ExternalDocLink instance.

See also
FormulaToken, ExternalReference
Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.