HyperlinkCollection
Contents
[
Hide
]HyperlinkCollection class
Encapsulates a collection of Hyperlink objects.
class HyperlinkCollection;
Methods
| Method | Description |
|---|---|
| get(number) | Gets the Hyperlink element at the specified index. |
| add(number, number, number, number, string) | Adds a hyperlink to a specified cell or a range of cells. |
| add(string, number, number, string) | Adds a hyperlink to a specified cell or a range of cells. |
| add(string, string, string, string, string) | Adds a hyperlink to a specified cell or a range of cells. |
| removeAt(number) | Remove the hyperlink at the specified index in this collection. |
| clear() | Clears all hyperlinks. |
| getCount() | Gets the number of elements contained in. |
get(number)
Gets the Hyperlink element at the specified index.
get(index: number) : Hyperlink;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index of the element. |
Returns
The element at the specified index.
add(number, number, number, number, string)
Adds a hyperlink to a specified cell or a range of cells.
add(firstRow: number, firstColumn: number, totalRows: number, totalColumns: number, address: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| firstRow | number | First row of the hyperlink range. |
| firstColumn | number | First column of the hyperlink range. |
| totalRows | number | Number of rows in this hyperlink range. |
| totalColumns | number | Number of columns of this hyperlink range. |
| address | string | Address of the hyperlink. |
Returns
Hyperlink object index.
add(string, number, number, string)
Adds a hyperlink to a specified cell or a range of cells.
add(cellName: string, totalRows: number, totalColumns: number, address: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cellName | string | Cell name. |
| totalRows | number | Number of rows in this hyperlink range. |
| totalColumns | number | Number of columns of this hyperlink range. |
| address | string | Address of the hyperlink. |
Returns
Hyperlink object index.
add(string, string, string, string, string)
Adds a hyperlink to a specified cell or a range of cells.
add(startCellName: string, endCellName: string, address: string, textToDisplay: string, screenTip: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startCellName | string | The top-left cell of the range. |
| endCellName | string | The bottom-right cell of the range. |
| address | string | Address of the hyperlink. |
| textToDisplay | string | The text to be displayed for the specified hyperlink. |
| screenTip | string | The screenTip text for the specified hyperlink. |
Returns
Hyperlink object index.
removeAt(number)
Remove the hyperlink at the specified index in this collection.
removeAt(index: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index of the element. |
clear()
Clears all hyperlinks.
clear() : void;
getCount()
Gets the number of elements contained in.
getCount() : number;