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

unpublished 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:)
is used to access named objects within a container.
::com::sun::star::container::XIndexAccess
(referenced interface's summary:)
provides access to the elements of a collection through an index.
::com::sun::star::container::XEnumerationAccess
(referenced interface's summary:)
used to enumerate objects in a container which contains objects.
Description
Primary interface for the ExternalDocLink service.

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

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
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 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 ExternalDocLinks instance.

Top of Page