CrossReference

A cross reference to a different index topic. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)

CrossReference

Property	Type	Access	Description
crossReferenceType	CrossReferenceType: CrossReferenceType.SEE_OR_ALSO_BRACKET CrossReferenceType.SEE CrossReferenceType.SEE_ALSO CrossReferenceType.SEE_HEREIN CrossReferenceType.SEE_ALSO_HEREIN CrossReferenceType.CUSTOM_CROSS_REFERENCE CrossReferenceType.CUSTOM_CROSS_REFERENCE_BEFORE CrossReferenceType.CUSTOM_CROSS_REFERENCE_AFTER	r/w	The text that precedes or follows the referenced topic.
customTypeString	string	r/w	The text used for a custom cross reference type. Note: Valid only for custom cross reference types.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the CrossReference.
index	number	readonly	The index of the CrossReference 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 CrossReference; this is an alias to the CrossReference's label property.
parent	Topic	readonly	The parent of the CrossReference (a Topic).
properties	Object	r/w	A property that allows setting of several properties at the same time.
referencedTopic	Topic	r/w	The topic to which this CrossReference points.

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

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)

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

string toSpecifier ()
Retrieves the object specifier.

CrossReference CrossReferences.nextItem (obj: CrossReference)

CrossReference CrossReferences.previousItem (obj: CrossReference)

Array of CrossReference CrossReference.getElements ()

CrossReference CrossReferences.[] (index: number)

CrossReference CrossReferences.add (referencedTopic: Topic, crossReferenceType: CrossReferenceType[, customTypeString: string][, withProperties: Object])

CrossReference CrossReferences.anyItem ()

CrossReference CrossReferences.firstItem ()

CrossReference CrossReferences.item (index: varies)

CrossReference CrossReferences.itemByID (id: number)

CrossReference CrossReferences.itemByName (name: string)

Array of CrossReference CrossReferences.itemByRange (from: varies, to: varies)

CrossReference CrossReferences.lastItem ()

CrossReference CrossReferences.middleItem ()

CrossReference CrossReferences.nextItem (obj: CrossReference)

CrossReference CrossReferences.previousItem (obj: CrossReference)

Jongware, 28-Apr-2012 v3.0.3i