K4 InDesign Javascript API Documentation

HyperlinksHyperlinkTextSource

A hyperlinked text object or insertion point.

Instance Properties

Name Description Access
appliedCharacterStyle CharacterStyle Character style of the hyperlink text source. 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 HyperlinkTextSource. read-only
index number The index of the HyperlinkTextSource 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 HyperlinkTextSource. read-write
parent Document The parent of the HyperlinkTextSource (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
sourceText Text The hyperlinked text or insertion point. read-write

Methods

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