K4 InDesign Javascript API Documentation

HyperlinksHyperlink

A hyperlink.

Instance Properties

Name Description Access
borderColor The hyperlink border color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. read-write
borderStyle HyperlinkAppearanceStyle The hyperlink border style. read-write
destination The text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination. 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
highlight HyperlinkAppearanceHighlight The hyperlink highlight style. read-write
id number The unique ID of the Hyperlink. read-only
index number The index of the Hyperlink 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 Hyperlink. read-write
parent Document The parent of the Hyperlink (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
source The hyperlinked text or page item. Can return: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource. read-write
visible bool If true, the Hyperlink is visible. read-write
width HyperlinkAppearanceWidth The stroke weight of the hyperlink border. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → Hyperlink
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
showDestination(
)
showSource(
)
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(
)
  → Hyperlink
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 Hyperlink.
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.
showSource(
)
Jumps to the hyperlink source.
toSource(
)
  → string
Generates a string which, if executed, will return the Hyperlink.
toSpecifier(
)
  → string
Retrieves the object specifier.