Class
A collection of cross references. add, count
CrossReferences
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
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) |
number count ()
Displays the number of elements in the CrossReference.
Element of
Topic.crossReferences
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |