K4 InDesign Javascript API Documentation

HyperlinksHyperlinkExternalPageDestination

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.

Instance Properties

Name Description Access
destinationPageIndex number The index of the page that the hyperlink destination points to. Note: Valid only when hyperlink destination is an external page. read-write
documentPath File The path to the document that the hyperlink destination points to. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
hidden bool If true, the hyperlink is hidden. read-only
id number The unique ID of the HyperlinkExternalPageDestination. read-only
index number The index of the HyperlinkExternalPageDestination within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the HyperlinkExternalPageDestination. read-only
parent Document The parent of the HyperlinkExternalPageDestination (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
viewBounds 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. read-write
viewPercentage number The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed. read-write
viewSetting HyperlinkDestinationPageSetting The destination page size when the page is reached by clicking the hyperlink. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → HyperlinkExternalPageDestination
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
showDestination(
)
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → HyperlinkExternalPageDestination
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the HyperlinkExternalPageDestination.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
showDestination(
)
Jumps to the hyperlink destination.
toSource(
)
  → string
Generates a string which, if executed, will return the HyperlinkExternalPageDestination.
toSpecifier(
)
  → string
Retrieves the object specifier.