CrossReference

Methods:

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

Objects:

Boolean, CrossReferenceType, EventListeners, Events, Number, Object, String,

Property Listing

Property	Type	Access	Description
crossReferenceType	CrossReferenceType CrossReferenceType.CUSTOM_CROSS_REFERENCE CrossReferenceType.CUSTOM_CROSS_REFERENCE_AFTER CrossReferenceType.CUSTOM_CROSS_REFERENCE_BEFORE CrossReferenceType.SEE CrossReferenceType.SEE_ALSO CrossReferenceType.SEE_ALSO_HEREIN CrossReferenceType.SEE_HEREIN CrossReferenceType.SEE_OR_ALSO_BRACKET	read/write	The text that precedes or follows the referenced topic.
customTypeString	String	read/write	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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	read/write	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	read/write	A property that allows setting of several properties at the same time.
referencedTopic	Topic	read/write	The topic to which this CrossReference points.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

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

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

CrossReference getElements ()

Resolves the object specifier, creating an array of object references.

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

undefined remove ()

Deletes the CrossReference.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

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