<html> <head> <title>Interface XExternalSheetCache</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XExternalSheetCache-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sheet</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XExternalSheetCache</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Primary interface for the <a href="ExternalSheetCache.html">ExternalSheetCache</a> service. </dd> <dt><b/></dt> <dd/><dt><b/></dt> <dd/></dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#setCellValue">setCellValue</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#getCellValue">getCellValue</a></td> <td class="imsum_right">It retrieves a cached value from a specified cell position. The cached value can be either ::string or ::double. </td> </tr> <tr> <td class="imsum_left"><a href="#getAllRows">getAllRows</a></td> <td class="imsum_right">It returns a list of all row numbers where a cached cell or cells exist. The row numbers are sorted in ascending order. </td> </tr> <tr> <td class="imsum_left"><a href="#getAllColumns">getAllColumns</a></td> <td class="imsum_right">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. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#TokenIndex">TokenIndex</a></td> <td class="imsum_right">Index corresponding to this instance of an external sheet cache for usage in formula tokens. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="setCellValue" class="membertitle">setCellValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setCellValue</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nColumn,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nRow,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> aValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> <dt><b>Parameter nRow</b></dt> <dd>row position (0-based) </dd> <dt><b>Parameter nColumn</b></dt> <dd>column position (0-based) </dd> <dt><b>Parameter aValue</b></dt> <dd>cell value to be cached </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCellValue" class="membertitle">getCellValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>getCellValue</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nColumn,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nRow )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>It retrieves a cached value from a specified cell position. The cached value can be either ::string or ::double. </dd> <dt><b>Returns</b></dt> <dd>any cached cell value </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAllRows" class="membertitle">getAllRows</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< long ></td> </tr> <tr> <td valign="top"><b>getAllRows</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>It returns a list of all row numbers where a cached cell or cells exist. The row numbers are sorted in ascending order. </dd> <dt><b>Returns</b></dt> <dd>sequence<long> list of all row numbers with cached cell(s) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAllColumns" class="membertitle">getAllColumns</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< long ></td> </tr> <tr> <td valign="top"><b>getAllColumns</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nRow )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> <dt><b>Returns</b></dt> <dd>sequence<long> list of all columns numbers with cached cell values </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="TokenIndex" class="membertitle">TokenIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>TokenIndex</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Index corresponding to this instance of an external sheet cache for usage in formula tokens. </dd> <dd><p>This index to the external sheet cache is expected in the <a href="SingleReference.html">SingleReference</a>::<a href="SingleReference.html#Sheet">Sheet</a> member if it is part of an external reference token. <p>Each external sheet cache has a unique index value inside the <a href="ExternalDocLink.html">ExternalDocLink</a> instance.</p> </dd> <dt><b/></dt> <dd/><dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2010 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
