Adobe InDesign CS6 (8.0) Object Model JS: Hyperlink

InDesign CS6

Class

Hyperlink

 A hyperlink.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, showDestination, showSource, toSource, toSpecifier

Hierarchy

Document
Hyperlink
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
borderColor3 Reals (0 - 255)
UIColors
r/wThe hyperlink border color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
borderStyleHyperlinkAppearanceStyle:
HyperlinkAppearanceStyle.SOLID
HyperlinkAppearanceStyle.DASHED
r/wThe hyperlink border style.
destinationHyperlinkExternalPageDestination
HyperlinkPageDestination
HyperlinkTextDestination
HyperlinkURLDestination
ParagraphDestination
r/wThe text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
hiddenbool readonlyIf true, the hyperlink is hidden.
highlightHyperlinkAppearanceHighlight:
HyperlinkAppearanceHighlight.NONE
HyperlinkAppearanceHighlight.INVERT
HyperlinkAppearanceHighlight.OUTLINE
HyperlinkAppearanceHighlight.INSET
r/wThe hyperlink highlight style.
idnumber readonlyThe unique ID of the Hyperlink.
indexnumber readonlyThe index of the Hyperlink within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the Hyperlink.
parentDocument readonlyThe parent of the Hyperlink (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
sourceCrossReferenceSource
HyperlinkPageItemSource
HyperlinkTextSource
r/wThe hyperlinked text or page item. Can return: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.
visiblebool r/wIf true, the Hyperlink is visible.
widthHyperlinkAppearanceWidth:
HyperlinkAppearanceWidth.THIN
HyperlinkAppearanceWidth.MEDIUM
HyperlinkAppearanceWidth.THICK
r/wThe stroke weight of the hyperlink border.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Hyperlink getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the Hyperlink.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void showDestination ()
Jumps to the hyperlink destination.

void showSource ()
Jumps to the hyperlink source.

string toSource ()
Generates a string which, if executed, will return the Hyperlink.

string toSpecifier ()
Retrieves the object specifier.

Used in:

Hyperlink Hyperlinks.nextItem (obj: Hyperlink)

Hyperlink Hyperlinks.previousItem (obj: Hyperlink)

Return

Array of Hyperlink Hyperlink.getElements ()

Hyperlink Hyperlinks.[] (index: number)

Hyperlink Hyperlinks.add (hyperlinkSource: varies[, hyperlinkDestination: varies][, withProperties: Object])

Hyperlink Hyperlinks.anyItem ()

Array of Hyperlink Hyperlinks.everyItem ()

Hyperlink Hyperlinks.firstItem ()

Hyperlink Hyperlinks.item (index: varies)

Hyperlink Hyperlinks.itemByID (id: number)

Hyperlink Hyperlinks.itemByName (name: string)

Array of Hyperlink Hyperlinks.itemByRange (from: varies, to: varies)

Hyperlink Hyperlinks.lastItem ()

Hyperlink Hyperlinks.middleItem ()

Hyperlink Hyperlinks.nextItem (obj: Hyperlink)

Hyperlink Hyperlinks.previousItem (obj: Hyperlink)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index