CrossReference

A cross reference to a different index topic. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)

Methods:

extractLabel, insertLabel, remove

Objects:

CrossReferenceType, 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.

id

Number

readonly

The unique ID of the CrossReference.

index

Number

readonly

The index of the CrossReference within its containing object.

label

String

read/write

A property that can be set to any string.

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

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

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.

Return

CrossReferences.add()