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

Property	Type	Access	Description
appliedCharacterStyle	CharacterStyle	r/w	Character style of the hyperlink text source.
appliedFormat	CrossReferenceFormat	r/w	Format used for cross reference source.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
hidden	bool	readonly	If true, the hyperlink is hidden.
id	number	readonly	The unique ID of the CrossReferenceSource.
index	number	readonly	The index of the CrossReferenceSource within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the CrossReferenceSource.
parent	Document	readonly	The parent of the CrossReferenceSource (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
sourceText	Text	r/w	The hyperlinked text or insertion point.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove ()
Deletes the CrossReferenceSource.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.3i

Contents :: Index