CrossReferences
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
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.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 | 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.
Array
of CrossReference everyItem ()
Returns every CrossReference in the collection.
CrossReference firstItem ()
Returns the first CrossReference in the collection.
CrossReference item (index:
varies)
Returns the CrossReference with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer 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. |
Array
of CrossReference itemByRange (from:
varies, to:
varies)
Returns the CrossReferences within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | CrossReference Long Integer String | The CrossReference, index, or name at the beginning of the range. Can accept: CrossReference, Long Integer or String. |
| to | CrossReference Long Integer 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.
Element of
Topic.crossReferences
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |