CrossReference
An index cross reference.
CrossReference Properties
| Property |
Type |
Access |
Description |
| crossReferenceType |
CrossReferenceType enumeration |
r/w |
The cross reference type. |
| customTypeString |
String |
r/w |
The string if a custom cross reference. |
| id |
Long |
read |
A unique number identifying the object. |
| index |
Long |
read |
Index of the object within its parent object. |
| label |
String |
r/w |
A label that can be set to any string. |
| parent |
Object |
read |
The parent of the object. |
| properties |
An array of property names and values |
r/w |
Property that allows setting of several properties at the same time. |
| referencedTopic |
Topic |
r/w |
The referenced topic. |
CrossReference Methods
| Method |
Returns |
Description |
| extractLabel |
String |
Gets the content of the label associated with the specified key (name). |
| getElements |
Array of Objects |
Resolve the object specifier. |
| insertLabel |
Nothing |
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| remove |
Nothing |
Delete the object. |
| toSource |
String |
Generate JavaScript source that, if executed, will return the specified objects. |
| toSpecifier |
String |
Retrieve the object specifier. |