A collection of hyperlinks.
Methods
Hyperlinkadd (hyperlinkSource:
any[, hyperlinkDestination:
any][, withProperties:
Object])
Creates a new hyperlink.
| Parameter | Type | Description |
|---|---|---|
| hyperlinkSource | HyperlinkPageItemSource HyperlinkTextSource |
The hyperlinked object. For information, see hyperlink page item source or hyperlink text source. Can accept: HyperlinkPageItemSource or HyperlinkTextSource. |
| hyperlinkDestination | Array of Strings Long Integers Booleans HyperlinkTextDestination HyperlinkPageDestination HyperlinkExternalPageDestination or HyperlinkURLDestination |
The destination that the hyperlink points to. For information, see hyperlink page destination, hyperlink external page destination, hyperlink text destination, or hyperlink url destination. Can accept: Array of Strings, Long Integers or Booleans, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or HyperlinkURLDestination. (Optional) |
| withProperties | Object | Initial values for properties of the new Hyperlink (Optional) |
HyperlinkanyItem ()
Returns any Hyperlink in the collection.
number count ()
Displays the number of elements in the Hyperlink.
Array of HyperlinkeveryItem ()
Returns every Hyperlink in the collection.
HyperlinkfirstItem ()
Returns the first Hyperlink in the collection.
Hyperlinkitem (index:
any)
Returns the Hyperlink with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
HyperlinkitemByID (id:
number)
Returns the Hyperlink with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
HyperlinkitemByName (name:
string)
Returns the Hyperlink with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of HyperlinkitemByRange (from:
any, to:
any)
Returns the Hyperlinks within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Hyperlink Long Integer String |
The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long Integer or String. |
| to | Hyperlink Long Integer String |
The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long Integer or String. |
HyperlinklastItem ()
Returns the last Hyperlink in the collection.
HyperlinkmiddleItem ()
Returns the middle Hyperlink in the collection.
HyperlinknextItem (obj:
Hyperlink)
Returns the Hyperlink whose index follows the specified Hyperlink in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Hyperlink | The Hyperlink whose index comes before the desired Hyperlink. |
HyperlinkpreviousItem (obj:
Hyperlink)
Returns the Hyperlink with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Hyperlink | The index of the Hyperlink that follows the desired Hyperlink. |
string toSource ()
Generates a string which, if executed, will return the Hyperlink.
Element of:
Document.hyperlinks