InDesign Server2025
API 20.5.0.49

HyperlinkPageDestinations

A collection of hyperlink page destinations.

Properties

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

Methods

HyperlinkPageDestination

Creates a new hyperlink page destination.

destination? Page The document page that the hyperlink points to.
withProperties? Object Initial values for properties of the new HyperlinkPageDestination
Number

Displays the number of elements in the HyperlinkPageDestination.

HyperlinkPageDestination

Returns the HyperlinkPageDestination with the specified index or name.

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

Returns the HyperlinkPageDestinations within the specified range.

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

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

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

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

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

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

Object of 1

Properties elsewhere that hold a HyperlinkPageDestinations.