LibreOffice
LibreOffice 25.8 SDK API Reference
|
Primary interface for the com::sun::star::sheet::ExternalDocLink service. More...
import "XExternalDocLink.idl";
Exported Interfaces | |
interface | com::sun::star::container::XNameAccess |
interface | com::sun::star::container::XIndexAccess |
interface | com::sun::star::container::XEnumerationAccess |
Public Member Functions | |
com::sun::star::sheet::XExternalSheetCache | addSheetCache ([in] string aSheetName, [in] boolean DynamicCache) |
Public Member Functions inherited from XNameAccess | |
any | getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException ) |
sequence< string > | getElementNames () |
boolean | hasByName ([in] string aName) |
Public Member Functions inherited from XElementAccess | |
type | getElementType () |
boolean | hasElements () |
Public Member Functions inherited from XInterface | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. | |
void | acquire () |
increases the reference counter by one. | |
void | release () |
decreases the reference counter by one. | |
Public Member Functions inherited from XIndexAccess | |
long | getCount () |
any | getByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException ) |
Public Member Functions inherited from XEnumerationAccess | |
com::sun::star::container::XEnumeration | createEnumeration () |
Public Attributes | |
long | TokenIndex |
Index corresponding to the external document link. |
Primary interface for the com::sun::star::sheet::ExternalDocLink service.
interface com::sun::star::container::XIndexAccess |
interface com::sun::star::container::XNameAccess |
com::sun::star::sheet::XExternalSheetCache addSheetCache | ( | [in] string | aSheetName, |
[in] boolean | DynamicCache ) |
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.
aSheetName | sheet name |
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. |
|
attributereadonly |
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.