CrossReferences

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

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

CrossReference [] (index:Number)

Returns the CrossReference with the specified index.

Parameter

Type

Description

index

Number

The index.

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)

CrossReference anyItem ()

Returns any CrossReference in the collection.

Number count ()

Displays the number of elements in the CrossReference.

CrossReference everyItem ()

Returns every CrossReference in the collection.

CrossReference firstItem ()

Returns the first CrossReference in the collection.

CrossReference item (index:Varies LongInteger String)

Returns the CrossReference with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

CrossReference itemByID (id:Number)

Returns the CrossReference with the specified ID.

Parameter

Type

Description

id

Number

The ID.

CrossReference itemByName (name:String)

Returns the CrossReference with the specified name.

Parameter

Type

Description

name

String

The name.

CrossReference itemByRange (from:Varies CrossReference LongInteger String, to:Varies CrossReference LongInteger String)

Returns the CrossReferences within the specified range.

Parameter

Type

Description

from

CrossReference

LongInteger

String

The CrossReference, index, or name at the beginning of the range. Can accept: CrossReference, Long Integer or String.

to

CrossReference

LongInteger

String

The CrossReference, index, or name at the end of the range. Can accept: CrossReference, Long Integer or String.

CrossReference lastItem ()

Returns the last CrossReference in the collection.

CrossReference middleItem ()

Returns the middle CrossReference in the collection.

CrossReference nextItem (obj:CrossReference)

Returns the CrossReference whose index follows the specified CrossReference in the collection.

Parameter

Type

Description

obj

CrossReference

The CrossReference whose index comes before the desired CrossReference.

CrossReference previousItem (obj:CrossReference)

Returns the CrossReference with the index previous to the specified index.

Parameter

Type

Description

obj

CrossReference

The index of the CrossReference that follows the desired CrossReference.

String toSource ()

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

Object of

Topic.crossReferences