CrossReferences

A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)

Methods:

add, count

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

CrossReference add (referencedTopic:Topic, crossReferenceType:CrossReferenceType, customTypeString:String, withProperties:Object)

Creates a new cross reference.

Parameter

Type

Description

referencedTopic

Topic

The topic that the cross reference points to.

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

The cross reference type.

customTypeString

String

The custom string to use in the cross reference. Valid only for custom cross reference types. (Optional)

withProperties

Object

Initial values for properties of the new CrossReference (Optional)

Number count ()

Displays the number of elements in the CrossReference.

Object of

Topic.crossReferences