Hyperlinks
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Hyperlink add (hyperlinkSource:
any[, hyperlinkDestination:
any][, withProperties:
Object])
Creates a new hyperlink.
| Parameter | Type | Description |
|---|---|---|
| hyperlinkSource | HyperlinkPageItemSource HyperlinkTextSource | The hyperlinked object. Can accept: HyperlinkPageItemSource or HyperlinkTextSource. |
| hyperlinkDestination |
Array
of Strings Booleans HyperlinkExternalPageDestination HyperlinkPageDestination HyperlinkTextDestination HyperlinkURLDestination Longs | The destination that the hyperlink points to. . Can accept: Array of Strings, Longs or Booleans, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or HyperlinkURLDestination. (Optional) |
| withProperties | Object | Initial values for properties of the new Hyperlink (Optional) |
Hyperlink anyItem ()
Returns any Hyperlink in the collection.
number count ()
Displays the number of elements in the Hyperlink.
Array
of Hyperlink everyItem ()
Returns every Hyperlink in the collection.
Hyperlink firstItem ()
Returns the first Hyperlink in the collection.
Hyperlink item (index:
any)
Returns the Hyperlink with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long String | The index or name. Can accept: Long or String. |
Hyperlink itemByID (id:
number)
Returns the Hyperlink with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
Hyperlink itemByName (name:
string)
Returns the Hyperlink with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of Hyperlink itemByRange (from:
any, to:
any)
Returns the Hyperlinks within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Hyperlink Long String | The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long or String. |
| to | Hyperlink Long String | The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long or String. |
Hyperlink lastItem ()
Returns the last Hyperlink in the collection.
Hyperlink middleItem ()
Returns the middle Hyperlink in the collection.
Hyperlink nextItem (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. |
Hyperlink previousItem (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
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |