K4 InDesign Javascript API Documentation

TextIndexingSortOption

An indexing sort option.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
headerType The header type. Can return: HeaderTypes enumerator or NothingEnum enumerator. read-write
include bool If true, include this indexing sort option. read-write
index number The index of the IndexingSortOption 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 IndexingSortOption. read-only
parent The parent of the IndexingSortOption (a Application or Document). read-only
priority number Priority of this indexing sort option (shuffles prior entries down). read-write
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → IndexingSortOption
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)
getElements(
)
  → IndexingSortOption
Resolves the object specifier, creating an array of object references.
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 IndexingSortOption.
toSpecifier(
)
  → string
Retrieves the object specifier.