Adobe InDesign CS4 (6.0) Object Model JS: HyperlinkTextSource

InDesign CS4

Class

HyperlinkTextSource

 

A hyperlinked text object or insertion point.

Superclass of CrossReferenceSource

QuickLinks

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

Hierarchy

Document
HyperlinkTextSource
CrossReferenceSource

Properties

PropertyTypeAccessDescription
appliedCharacterStyleCharacterStyle r/wCharacter style of the hyperlink text source.
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the HyperlinkTextSource.
indexnumber readonlyThe index of the HyperlinkTextSource 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 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.

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

void showSource ()
Jumps to the hyperlink source.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Hyperlink.source

Used in:

array of HyperlinkTextSource HyperlinkTextSources.itemByRange (from: any, to: any)

HyperlinkTextSource HyperlinkTextSources.nextItem (obj: HyperlinkTextSource)

HyperlinkTextSource HyperlinkTextSources.previousItem (obj: HyperlinkTextSource)

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

Return

Array of HyperlinkTextSource HyperlinkTextSource.getElements ()

HyperlinkTextSource HyperlinkTextSources.[] (index: number)

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

HyperlinkTextSource HyperlinkTextSources.anyItem ()

Array of HyperlinkTextSource HyperlinkTextSources.everyItem ()

HyperlinkTextSource HyperlinkTextSources.firstItem ()

HyperlinkTextSource HyperlinkTextSources.item (index: any)

HyperlinkTextSource HyperlinkTextSources.itemByID (id: number)

HyperlinkTextSource HyperlinkTextSources.itemByName (name: string)

Array of HyperlinkTextSource HyperlinkTextSources.itemByRange (from: any, to: any)

HyperlinkTextSource HyperlinkTextSources.lastItem ()

HyperlinkTextSource HyperlinkTextSources.middleItem ()

HyperlinkTextSource HyperlinkTextSources.nextItem (obj: HyperlinkTextSource)

HyperlinkTextSource HyperlinkTextSources.previousItem (obj: HyperlinkTextSource)

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