Collection of Hyperlink

Hyperlinks

A collection of hyperlinks.

Properties

Name	Type	Access	Description
	Number	readonly	The number of objects in the collection.

Methods

→ Hyperlink

Returns the Hyperlink with the specified index.

index Number The index.

→ Hyperlink

Creates a new hyperlink.

hyperlinkSource HyperlinkPageItemSource | HyperlinkTextSource | CrossReferenceSource The hyperlinked object. Can accept: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.

hyperlinkDestination? HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkTextDestination | HyperlinkURLDestination | Array | LongInteger | LongInteger | LongInteger | String | ParagraphDestination The destination that the hyperlink points to. Can accept: Ordered array containing fileName:String, volumn:String, directoryId:Long Integer, dataLinkClassId:Long Integer, destinationUid:Long Integer, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination.

withProperties? Object Initial values for properties of the new Hyperlink

→ Hyperlink

Returns any Hyperlink in the collection.

→ Number

Displays the number of elements in the Hyperlink.

→ Hyperlink[]

Returns every Hyperlink in the collection.

→ Hyperlink

Returns the first Hyperlink in the collection.

→ Hyperlink

Returns the Hyperlink with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.

→ Hyperlink

Returns the Hyperlink with the specified ID.

id Number The ID.

→ Hyperlink

Returns the Hyperlink with the specified name.

name String The name.

→ Hyperlink[]

Returns the Hyperlinks within the specified range.

from Hyperlink | LongInteger | String The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long Integer or String.

to Hyperlink | LongInteger | String The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long Integer or String.

→ Hyperlink

Returns the last Hyperlink in the collection.

→ Hyperlink

Returns the middle Hyperlink in the collection.

→ Hyperlink

Returns the Hyperlink whose index follows the specified Hyperlink in the collection.

obj Hyperlink The Hyperlink whose index comes before the desired Hyperlink.

→ Hyperlink

Returns the Hyperlink with the index previous to the specified index.

obj Hyperlink The index of the Hyperlink that follows the desired Hyperlink.

→ String

Generates a string which, if executed, will return the Hyperlink.

Object of 1

Properties elsewhere that hold a Hyperlinks.

Document.hyperlinks