Adobe InDesign CS (3.0) Object Model JS: CrossReference

previous page next page

Class

CrossReference

A cross reference to a different index topic.

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

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

Parameter	Type	Description
key	string	The key.

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.

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

Jongware, 27-Jun-2010 v3.0.3d

previous page start next page