ExternalLink
Contents
[
Hide
]ExternalLink class
Represents an external link in a workbook.
class ExternalLink;
Example
const { Workbook } = require("aspose.cells.node");
//Open a file with external links
var workbook = new Workbook("input/Externlink.xls");
//Get External Link
var externalLink = workbook.getWorksheets().getExternalLinks().get(0);
//Change External Link's Data Source
externalLink.setDataSource("input/Book1.xls");
Methods
| Method | Description |
|---|---|
| getType() | Gets the type of external link. |
| getPathType() | Get the path type of this external link |
| getOriginalDataSource() | Represents stored data source of the external link. |
| setOriginalDataSource(string) | Represents stored data source of the external link. |
| getDataSource() | Represents data source of the external link. |
| setDataSource(string) | Represents data source of the external link. |
| isReferred() | Indicates whether this external link is referenced by others. |
| isVisible() | Indicates whether this external link is visible in MS Excel. |
| addExternalName(string, string) | Adds an external name. |
| isNull() | Checks whether the implementation object is null. |
getType()
Gets the type of external link.
getType() : ExternalLinkType;
Returns
getPathType()
Get the path type of this external link
getPathType() : string;
getOriginalDataSource()
Represents stored data source of the external link.
getOriginalDataSource() : string;
setOriginalDataSource(string)
Represents stored data source of the external link.
setOriginalDataSource(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getDataSource()
Represents data source of the external link.
getDataSource() : string;
setDataSource(string)
Represents data source of the external link.
setDataSource(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
isReferred()
Indicates whether this external link is referenced by others.
isReferred() : boolean;
isVisible()
Indicates whether this external link is visible in MS Excel.
isVisible() : boolean;
addExternalName(string, string)
Adds an external name.
addExternalName(text: string, referTo: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| text | string | The text of the external name. /// If the external name belongs to a worksheet, the text should be as Sheet1!Text. |
| referTo | string | The referTo of the external name. It must be a cell or the range. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;