K4 InDesign Javascript API Documentation

HyperlinksHyperlinkPageDestination

A hyperlink destination that is a document page.

Instance Properties

Name Description Access
destinationPage Page The page that the hyperlink 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 HyperlinkPageDestination. read-only
index number The index of the HyperlinkPageDestination 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 HyperlinkPageDestination. read-write
nameManually bool 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. read-write
parent Document The parent of the HyperlinkPageDestination (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(
)
  → HyperlinkPageDestination
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(
)
  → HyperlinkPageDestination
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 HyperlinkPageDestination.
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 HyperlinkPageDestination.
toSpecifier(
)
  → string
Retrieves the object specifier.