A cross reference to a different index topic. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)
Go to Property Listing | Method Listing
extractLabel, getElements, insertLabel, remove, toSource, toSpecifier
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
read/write |
The text that precedes or follows the referenced topic. |
||
|
read/write |
The text used for a custom cross reference type. Note: Valid only for custom cross reference types. |
||
|
readonly |
The unique ID of the CrossReference. |
||
|
readonly |
The index of the CrossReference within its containing object. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
readonly |
The parent of the CrossReference (a Topic). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
read/write |
The topic to which this CrossReference points. |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
CrossReference getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined remove ()
Deletes the CrossReference.
String toSource ()
Generates a string which, if executed, will return the CrossReference.
String toSpecifier ()
Retrieves the object specifier.