Adobe InDesign CS2 (4.0) Object Model JS: Hyperlink

InDesign CS2

Class

Hyperlink

 A hyperlink.

QuickLinks

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

Hierarchy

Document
Hyperlink

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
r/wThe text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or HyperlinkURLDestination.
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.
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.
sourceHyperlinkPageItemSource
HyperlinkTextSource
r/wThe hyperlinked text or page item. Can return: HyperlinkPageItemSource or HyperlinkTextSource.
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

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

ParameterTypeDescription
keystringThe key.

Array of Object 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.

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.

Element of

GotoAnchorBehavior.anchorItem

Used in:

array of Hyperlink Hyperlinks.itemByRange (from: any, to: any)

Hyperlink Hyperlinks.nextItem (obj: Hyperlink)

Hyperlink Hyperlinks.previousItem (obj: Hyperlink)

Return

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

Hyperlink Hyperlinks.anyItem ()

Array of Hyperlink Hyperlinks.everyItem ()

Hyperlink Hyperlinks.firstItem ()

Hyperlink Hyperlinks.item (index: any)

Hyperlink Hyperlinks.itemByID (id: number)

Hyperlink Hyperlinks.itemByName (name: string)

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

Hyperlink Hyperlinks.lastItem ()

Hyperlink Hyperlinks.middleItem ()

Hyperlink Hyperlinks.nextItem (obj: Hyperlink)

Hyperlink Hyperlinks.previousItem (obj: Hyperlink)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index