Adobe InDesign CS (3.0) Object Model JS: CrossReference

InDesign CS

Class

CrossReference

 A cross reference to a different index topic.

QuickLinks

extractLabel, insertLabel, remove

Hierarchy

Topic
CrossReference

Properties

PropertyTypeAccessDescription
crossReferenceTypeCrossReferenceType:
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/wThe text that precedes or follows the referenced topic.
customTypeStringstring r/wThe text used for a custom cross reference type. Note: Valid only for custom cross reference types.
idnumber readonlyThe unique ID of the CrossReference.
indexnumber readonlyThe index of the CrossReference within its containing object.
labelstring r/wA property that can be set to any string.
parentTopic readonlyThe parent of the CrossReference (a Topic).
propertiesObject r/wA property that allows setting of several properties at the same time.
referencedTopicTopic r/wThe topic to which this CrossReference points.

Methods

Instances

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

ParameterTypeDescription
keystringThe key.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the CrossReference.

Return

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

Jongware, 27-Jun-2010 v3.0.3dContents :: Index