CrossReference

A cross reference to a different index topic.

Properties

Property	Type	Access	Description
crossReferenceType	CrossReferenceType : SEE_OR_ALSO_BRACKET SEE SEE_ALSO SEE_HEREIN SEE_ALSO_HEREIN CUSTOM_CROSS_REFERENCE CUSTOM_CROSS_REFERENCE_BEFORE 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.
id	number	readonly	The unique ID of the CrossReference.
index	number	readonly	The index of the CrossReference within its containing object.
label	string	r/w	A property that can be set to any string.
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 the cross reference points.

Methods

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

Parameter	Type	Description
key	string	The key.

Array of CrossReferencegetElements ()
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.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

CrossReferences.previousItem (

obj:
CrossReference )

CrossReferences.nextItem (

obj:
CrossReference )

Returned by:

Array of CrossReference CrossReference .getElements (

)

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

CrossReference CrossReferences.anyItem (

)

Array of CrossReference CrossReferences.everyItem (

)

CrossReference CrossReferences.firstItem (

)

CrossReference CrossReferences.item (
index:
any
)

CrossReference CrossReferences.itemByID (
id:
number
)

CrossReference CrossReferences.itemByName (
name:
string
)

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

CrossReference CrossReferences.lastItem (

)

CrossReference CrossReferences.middleItem (

)

CrossReference CrossReferences.nextItem (
obj:
CrossReference
)

CrossReference CrossReferences.previousItem (
obj:
CrossReference
)