HyperlinkCollection
Contents
[
Hide
]HyperlinkCollection class
Encapsulates a collection of Hyperlink objects.
Properties
| Name | Type | Description |
|---|---|---|
| Count | Number | |
| Item (int) | Hyperlink | Gets the Hyperlink element at the specified index. |
Methods
| Name | Description |
|---|---|
| add | Adds a hyperlink to a specified cell or a range of cells. |
| removeAt | Remove the hyperlink at the specified index in this collection. |
| clear | Clears all hyperlinks. |
| iterator | |
| get | Reserved for internal use. |
| contains | Reserved for internal use. |
| indexOf | Reserved for internal use. |
HyperlinkCollection.Count property
Type: Number
HyperlinkCollection.Item (int) property
Gets the Hyperlink element at the specified index.
Type: Hyperlink
add(firstRow, firstColumn, totalRows, totalColumns, address) (1 of 4)
Adds a hyperlink to a specified cell or a range of cells.
| 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.
Example:
$workbook = new cells\Workbook();
$worksheet = $workbook->getWorksheets()->get(0);
$worksheet->getHyperlinks()->add("A4", 1, 1, "http://www.aspose.com");
$worksheet->getHyperlinks()->add("A5", 1, 1, "c:\\book1.xls");
add(cellName, totalRows, totalColumns, address) (2 of 4)
Adds a hyperlink to a specified cell or a range of cells.
| 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(startCellName, endCellName, address, textToDisplay, screenTip) (3 of 4)
Adds a hyperlink to a specified cell or a range of cells.
| 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.
add(value) (4 of 4)
Reserved for internal use.
removeAt(index)
Remove the hyperlink at the specified index in this collection.
| Parameter | Type | Description |
|---|---|---|
| index | Number | The zero based index of the element. |
clear()
Clears all hyperlinks.
iterator()
get(index)
Reserved for internal use.
contains(value)
Reserved for internal use.
indexOf(value)
Reserved for internal use.