A collection of hyperlink page destinations.
Methods
HyperlinkPageDestinationadd ([destination:
Page][, withProperties:
Object])
Creates a new hyperlink page destination.
| Parameter | Type | Description |
|---|---|---|
| destination | Page | The document page that the hyperlink points to. (Optional) |
| withProperties | Object | Initial values for properties of the new HyperlinkPageDestination (Optional) |
HyperlinkPageDestinationanyItem ()
Returns any HyperlinkPageDestination in the collection.
number count ()
Displays the number of elements in the HyperlinkPageDestination.
Array of HyperlinkPageDestinationeveryItem ()
Returns every HyperlinkPageDestination in the collection.
HyperlinkPageDestinationfirstItem ()
Returns the first HyperlinkPageDestination in the collection.
HyperlinkPageDestinationitem (index:
any)
Returns the HyperlinkPageDestination with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
HyperlinkPageDestinationitemByID (id:
number)
Returns the HyperlinkPageDestination with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
HyperlinkPageDestinationitemByName (name:
string)
Returns the HyperlinkPageDestination with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of HyperlinkPageDestinationitemByRange (from:
any, to:
any)
Returns the HyperlinkPageDestinations within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | HyperlinkPageDestination Long Integer String |
The HyperlinkPageDestination, index, or name at the beginning of the range. Can accept: HyperlinkPageDestination, Long Integer or String. |
| to | HyperlinkPageDestination Long Integer String |
The HyperlinkPageDestination, index, or name at the end of the range. Can accept: HyperlinkPageDestination, Long Integer or String. |
HyperlinkPageDestinationlastItem ()
Returns the last HyperlinkPageDestination in the collection.
HyperlinkPageDestinationmiddleItem ()
Returns the middle HyperlinkPageDestination in the collection.
HyperlinkPageDestinationnextItem (obj:
HyperlinkPageDestination)
Returns the HyperlinkPageDestination whose index follows the specified HyperlinkPageDestination in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkPageDestination | The HyperlinkPageDestination whose index comes before the desired HyperlinkPageDestination. |
HyperlinkPageDestinationpreviousItem (obj:
HyperlinkPageDestination)
Returns the HyperlinkPageDestination with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkPageDestination | The index of the HyperlinkPageDestination that follows the desired HyperlinkPageDestination. |
string toSource ()
Generates a string which, if executed, will return the HyperlinkPageDestination.
Element of:
Document.hyperlinkPageDestinations