Class

CrossReferenceSource

 A cross reference text source object. Base Class: HyperlinkTextSource

QuickLinks

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

Hierarchy

Document
HyperlinkTextSource
CrossReferenceSource
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
appliedCharacterStyleCharacterStyle r/wCharacter style of the hyperlink text source.
appliedFormatCrossReferenceFormat r/wFormat used for cross reference 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 CrossReferenceSource.
indexnumber readonlyThe index of the CrossReferenceSource 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 CrossReferenceSource.
parentDocument readonlyThe parent of the CrossReferenceSource (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 CrossReferenceSource 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 CrossReferenceSource.

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

string toSpecifier ()
Retrieves the object specifier.

void update ()
Updates cross reference text source content.

Element of

Hyperlink.source

Used in:

CrossReferenceSource CrossReferenceSources.nextItem (obj: CrossReferenceSource)

CrossReferenceSource CrossReferenceSources.previousItem (obj: CrossReferenceSource)

Return

Array of CrossReferenceSource CrossReferenceSource.getElements ()

CrossReferenceSource CrossReferenceSources.[] (index: number)

CrossReferenceSource CrossReferenceSources.add (source: Text, appliedFormat: CrossReferenceFormat[, withProperties: Object])

CrossReferenceSource CrossReferenceSources.anyItem ()

Array of CrossReferenceSource CrossReferenceSources.everyItem ()

CrossReferenceSource CrossReferenceSources.firstItem ()

CrossReferenceSource CrossReferenceSources.item (index: varies)

CrossReferenceSource CrossReferenceSources.itemByID (id: number)

CrossReferenceSource CrossReferenceSources.itemByName (name: string)

Array of CrossReferenceSource CrossReferenceSources.itemByRange (from: varies, to: varies)

CrossReferenceSource CrossReferenceSources.lastItem ()

CrossReferenceSource CrossReferenceSources.middleItem ()

CrossReferenceSource CrossReferenceSources.nextItem (obj: CrossReferenceSource)

CrossReferenceSource CrossReferenceSources.previousItem (obj: CrossReferenceSource)

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