Adobe InDesign CS (3.0) Object Model JS: HyperlinkTextSource

InDesign CS

Class

HyperlinkTextSource

 A hyperlinked text object or insertion point.

QuickLinks

extractLabel, insertLabel, remove, showSource

Hierarchy

Document
HyperlinkTextSource

Properties

PropertyTypeAccessDescription
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the HyperlinkTextSource.
indexnumber readonlyThe index of the HyperlinkTextSource within its containing object.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the HyperlinkTextSource.
parentDocument readonlyThe parent of the HyperlinkTextSource (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
sourceTextText r/wThe hyperlinked text or insertion point.

Methods

Instances

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

ParameterTypeDescription
keystringThe key.

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 HyperlinkTextSource.

void showSource ()
Jumps to the hyperlink source.

Element of

Hyperlink.source

Used in:

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

Return

HyperlinkTextSource HyperlinkTextSources.add (source: Text[, withProperties: Object])

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