Class

HyperlinkTextSource

 

A hyperlinked text object or insertion point.

Superclass of CrossReferenceSource

QuickLinks

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

Hierarchy

Document
HyperlinkTextSource
CrossReferenceSource
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
appliedCharacterStyleCharacterStyle r/wCharacter style of the hyperlink text source.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
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

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

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 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:

HyperlinkTextSource HyperlinkTextSources.nextItem (obj: HyperlinkTextSource)

HyperlinkTextSource HyperlinkTextSources.previousItem (obj: HyperlinkTextSource)

Return

Array of HyperlinkTextSource Character.findHyperlinks ([sortOrder: RangeSortOrder])

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: varies)

HyperlinkTextSource HyperlinkTextSources.itemByID (id: number)

HyperlinkTextSource HyperlinkTextSources.itemByName (name: string)

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

HyperlinkTextSource HyperlinkTextSources.lastItem ()

HyperlinkTextSource HyperlinkTextSources.middleItem ()

HyperlinkTextSource HyperlinkTextSources.nextItem (obj: HyperlinkTextSource)

HyperlinkTextSource HyperlinkTextSources.previousItem (obj: HyperlinkTextSource)

Array of HyperlinkTextSource InsertionPoint.findHyperlinks ([sortOrder: RangeSortOrder])

Array of HyperlinkTextSource Line.findHyperlinks ([sortOrder: RangeSortOrder])

Array of HyperlinkTextSource Paragraph.findHyperlinks ([sortOrder: RangeSortOrder])

Array of HyperlinkTextSource Text.findHyperlinks ([sortOrder: RangeSortOrder])

Array of HyperlinkTextSource TextColumn.findHyperlinks ([sortOrder: RangeSortOrder])

Array of HyperlinkTextSource TextStyleRange.findHyperlinks ([sortOrder: RangeSortOrder])

Array of HyperlinkTextSource Word.findHyperlinks ([sortOrder: RangeSortOrder])

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