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

interface XExternalDocLink
Base Interfaces
XExternalDocLink
┣ ::com::sun::star::container::XNameAccess
┃ ┗ ::com::sun::star::container::XElementAccess
┣ ::com::sun::star::container::XIndexAccess
┃ ┗ ::com::sun::star::container::XElementAccess
┗ ::com::sun::star::container::XEnumerationAccess
   ┗ ::com::sun::star::container::XElementAccess

::com::sun::star::container::XNameAccess
(referenced interface's summary:)
::com::sun::star::container::XIndexAccess
(referenced interface's summary:)
::com::sun::star::container::XEnumerationAccess
(referenced interface's summary:)

Methods' Summary
addSheetCache  
Attributes' Summary
TokenIndex Index corresponding to the external document link.  
Methods' Details
addSheetCache
XExternalSheetCache
addSheetCache( [in] string  aSheetName,
[in] boolean  DynamicCache );

Description

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.

Note that a sheet name lookup is performed in a case-insensitive fashion.

Parameter aSheetName
sheet name
Parameter DynamicCache
specify whether or not the cache can grow when non-cached regions are queried. If `TRUE`, 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 `FALSE`, the source document will not be accessed, and the non-cached regions are treated as empty cells.
Returns
com::sun::star::sheet::XExternalSheetCache sheet cache instance
Attributes' Details
TokenIndex
[ readonly ] long TokenIndex;
Description
Index corresponding to the external document link.

This index value corresponds with the external document represented by an instance of com::sun::star::sheet::ExternalDocLink. This value is stored within a formula token instance.

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 com::sun::star::sheet::ExternalDocLinks instance.

See also
ExternalDocLinks, FormulaToken, ExternalReference
Top of Page