InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

HyperlinkPageDestination

A hyperlink destination that is a document page.

Hierarchy

Document

HyperlinkPageDestination

Properties

NameType AccessDescription
Page read/write The page that the hyperlink points to.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly If true, the hyperlink is hidden.
Number readonly The unique ID of the HyperlinkPageDestination.
Number readonly The index of the HyperlinkPageDestination within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the HyperlinkPageDestination.
Boolean read/write If true or unspecified, allows a custom destination name; also does not update the name when the destination is moved to a different page. If false, uses the page number as the page destination name and makes the name property read-only for the destination object; also updates the name when the destination is moved to a different page.
Document readonly The parent of the HyperlinkPageDestination (a Document).
Object read/write A property that allows setting of several properties at the same time.
Array | Unit | Unit | Unit read/write The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid only when view setting is fixed. Can return: Ordered array containing top:Unit, left:Unit, bottom:Unit, right:Unit.
Number 5–4000 read/write The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed.
HyperlinkDestinationPageSetting
 read/write The destination page size when the page is reached by clicking the hyperlink.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Gets the label value associated with the specified key.

key String The key.
→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the HyperlinkPageDestination.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Jumps to the hyperlink destination.

→ String

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

→ String

Retrieves the object specifier.

Object of 6

Properties elsewhere that hold a HyperlinkPageDestination.

Bookmark.destinationEvent.parentEventListener.parentGotoAnchorBehavior.anchorItemHyperlink.destinationMutationEvent.parent

Parameter of 5

Method parameters that accept a HyperlinkPageDestination.

Bookmarks.add(destination)HyperlinkPageDestinations.itemByRange(from)HyperlinkPageDestinations.nextItem(obj)HyperlinkPageDestinations.previousItem(obj)Hyperlinks.add(hyperlinkDestination)

Return 14

Methods that return a HyperlinkPageDestination.

HyperlinkPageDestination.getElements()HyperlinkPageDestinations.[]()HyperlinkPageDestinations.add()HyperlinkPageDestinations.anyItem()HyperlinkPageDestinations.everyItem()HyperlinkPageDestinations.firstItem()HyperlinkPageDestinations.item()HyperlinkPageDestinations.itemByID()HyperlinkPageDestinations.itemByName()HyperlinkPageDestinations.itemByRange()HyperlinkPageDestinations.lastItem()HyperlinkPageDestinations.middleItem()HyperlinkPageDestinations.nextItem()HyperlinkPageDestinations.previousItem()