K4 InDesign Javascript API Documentation

IndexingCrossReference

A cross reference to a different index topic. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)

Instance Properties

Name Description Access
crossReferenceType CrossReferenceType The text that precedes or follows the referenced topic. read-write
customTypeString string The text used for a custom cross reference type. Note: Valid only for custom cross reference types. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the CrossReference. read-only
index number The index of the CrossReference within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the CrossReference; this is an alias to the CrossReference's label property. read-write
parent Topic The parent of the CrossReference (a Topic). read-only
properties Object A property that allows setting of several properties at the same time. read-write
referencedTopic Topic The topic to which this CrossReference points. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → CrossReference
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → CrossReference
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the CrossReference.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the CrossReference.
toSpecifier(
)
  → string
Retrieves the object specifier.