InDesign Server2025
API 20.5.0.49

HyperlinkTextDestinations

A collection of hyperlink text destinations.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

HyperlinkTextDestination

Creates a new hyperlink text destination.

destination Text The text or insertion point location that the hyperlink points to.
withProperties? Object Initial values for properties of the new HyperlinkTextDestination
Number

Displays the number of elements in the HyperlinkTextDestination.

HyperlinkTextDestination

Returns the HyperlinkTextDestination with the specified index or name.

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

Returns the HyperlinkTextDestinations within the specified range.

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

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

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

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

obj HyperlinkTextDestination The index of the HyperlinkTextDestination that follows the desired HyperlinkTextDestination.
String

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

Object of 1

Properties elsewhere that hold a HyperlinkTextDestinations.