<html> <head> <title>Interface XExternalDocLink</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="XExternalDocLink-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 XExternalDocLink</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XExternalDocLink</strong> ┣ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> ┃ ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XElementAccess.html">XElementAccess</a> ┣ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a> ┃ ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XElementAccess.html">XElementAccess</a> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumerationAccess.html">XEnumerationAccess</a> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XElementAccess.html">XElementAccess</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>is used to access named objects within a container. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>provides access to the elements of a collection through an index. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumerationAccess.html">XEnumerationAccess</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>used to enumerate objects in a container which contains objects. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>Primary interface for the <a href="ExternalDocLink.html">ExternalDocLink</a> service. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1.0</dd> <dt><b>See also</b></dt> <dd><a href="ExternalDocLink.html">ExternalDocLink</a></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="#addSheetCache">addSheetCache</a></td> <td class="imsum_right"> </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 the external document link. </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="addSheetCache" class="membertitle">addSheetCache</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"><a href="XExternalSheetCache.html">XExternalSheetCache</a></td> </tr> <tr> <td valign="top"><b>addSheetCache</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aSheetName,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> DynamicCache );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd><p>This method adds a new sheet cache instance to the external document link for a specified sheet name. If a sheet cache instance already exists for the specified name, then the existing instance is returned.</p> <p>Note that a sheet name lookup is performed in a case-insensitive fashion.</p> </dd> <dt><b>Parameter aSheetName</b></dt> <dd>sheet name </dd> <dt><b>Parameter DynamicCache</b></dt> <dd>specify whether or not the cache can grow when non-cached regions are queried. If <b>true</b>, querying a non-cached cell in this sheet cache will allow Calc to try to access the source document to fetch the value in first access. If <b>false</b>, the source document will not be accessed, and the non-cached regions are treated as empty cells. </dd> <dt><b>Returns</b></dt> <dd>com::sun::star::sheet::XExternalSheetCache sheet cache instance </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 the external document link. </dd> <dd><p>This index value corresponds with the external document represented by an instance of <a href="ExternalDocLink.html">ExternalDocLink</a>. This value is stored within a formula token instance.</p> <p>Each external document cache instance has a unique index value, and this index value can be used to retrieve the corresponding external document cache from the parent <a href="ExternalDocLinks.html">ExternalDocLinks</a> instance.</p> </dd> <dt><b>See also</b></dt> <dd><a href="ExternalDocLinks.html">ExternalDocLinks</a>, <a href="FormulaToken.html">FormulaToken</a>, <a href="ExternalReference.html">ExternalReference</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>