K4 InDesign Javascript API Documentation

IndexingTopic

An index topic.

Instance Properties

Name Description Access
crossReferences CrossReferences A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.) read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the Topic within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the Topic. read-write
pageReferences PageReferences A collection of index page references. read-only
parent The parent of the Topic (a IndexSection, Topic or Index). read-only
properties Object A property that allows setting of several properties at the same time. read-write
sortOrder string The string by which the topic is sorted instead of the topic name is not used. Note: The actual topic text, rather than the sort order text, appears in the index. read-write
topics Topics A collection of index topics. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
capitalize(
[capitalizationOption])
getElements(
)
  → Topic
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)
capitalize(
[capitalizationOption=IndexCapitalizationOptions.ALL_ENTRIES])
Makes the initial letter for the specified index topic or group of index topics upper case.
capitalizationOption IndexCapitalizationOptions The entry or entries to capitalize. (Optional)
getElements(
)
  → Topic
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the Topic.
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 Topic.
toSpecifier(
)
  → string
Retrieves the object specifier.