K4 InDesign Javascript API Documentation

HyperlinksHyperlinkURLDestination

A hyperlink destination that is a URL.

Instance Properties

Name Description Access
destinationURL string The URL 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 HyperlinkURLDestination. read-only
index number The index of the HyperlinkURLDestination 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 HyperlinkURLDestination. read-write
parent Document The parent of the HyperlinkURLDestination (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → HyperlinkURLDestination
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(
)
  → HyperlinkURLDestination
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 HyperlinkURLDestination.
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 HyperlinkURLDestination.
toSpecifier(
)
  → string
Retrieves the object specifier.