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

HyperlinkExternalPageDestination

A hyperlink destination that is a page in a document other than the document that contains the hyperlink source. For information on hyperlink sources, hyperlink page item source or hyperlink text source.

Hierarchy

Document

HyperlinkExternalPageDestination

Properties

NameType AccessDescription
Number 1–9999 read/write The index of the page that the hyperlink destination points to. Note: Valid only when hyperlink destination is an external page.
File read/write The path to the document that the hyperlink destination 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 HyperlinkExternalPageDestination.
Number readonly The index of the HyperlinkExternalPageDestination 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 readonly The name of the HyperlinkExternalPageDestination.
Document readonly The parent of the HyperlinkExternalPageDestination (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 HyperlinkExternalPageDestination.

→ 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 HyperlinkExternalPageDestination.

→ String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a HyperlinkExternalPageDestination.

Bookmark.destinationEvent.parentEventListener.parentHyperlink.destinationMutationEvent.parent

Parameter of 5

Method parameters that accept a HyperlinkExternalPageDestination.

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

Return 14

Methods that return a HyperlinkExternalPageDestination.

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