A collection of hyperlink text destinations.
Methods
HyperlinkTextDestinationadd (destination:
Text[, withProperties:
Object])
Creates a new hyperlink text destination.
| Parameter | Type | Description |
|---|---|---|
| destination | Text | The text or insertion point location that the hyperlink points to. |
| withProperties | Object | Initial values for properties of the new HyperlinkTextDestination (Optional) |
HyperlinkTextDestinationanyItem ()
Returns any HyperlinkTextDestination in the collection.
number count ()
Displays the number of elements in the HyperlinkTextDestination.
Array of HyperlinkTextDestinationeveryItem ()
Returns every HyperlinkTextDestination in the collection.
HyperlinkTextDestinationfirstItem ()
Returns the first HyperlinkTextDestination in the collection.
HyperlinkTextDestinationitem (index:
any)
Returns the HyperlinkTextDestination with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
HyperlinkTextDestinationitemByID (id:
number)
Returns the HyperlinkTextDestination with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
HyperlinkTextDestinationitemByName (name:
string)
Returns the HyperlinkTextDestination with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of HyperlinkTextDestinationitemByRange (from:
any, to:
any)
Returns the HyperlinkTextDestinations within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | HyperlinkTextDestination Long Integer String |
The HyperlinkTextDestination, index, or name at the beginning of the range. Can accept: HyperlinkTextDestination, Long Integer or String. |
| to | HyperlinkTextDestination Long Integer String |
The HyperlinkTextDestination, index, or name at the end of the range. Can accept: HyperlinkTextDestination, Long Integer or String. |
HyperlinkTextDestinationlastItem ()
Returns the last HyperlinkTextDestination in the collection.
HyperlinkTextDestinationmiddleItem ()
Returns the middle HyperlinkTextDestination in the collection.
HyperlinkTextDestinationnextItem (obj:
HyperlinkTextDestination)
Returns the HyperlinkTextDestination whose index follows the specified HyperlinkTextDestination in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkTextDestination | The HyperlinkTextDestination whose index comes before the desired HyperlinkTextDestination. |
HyperlinkTextDestinationpreviousItem (obj:
HyperlinkTextDestination)
Returns the HyperlinkTextDestination with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkTextDestination | The index of the HyperlinkTextDestination that follows the desired HyperlinkTextDestination. |
string toSource ()
Generates a string which, if executed, will return the HyperlinkTextDestination.
Element of:
Document.hyperlinkTextDestinations