InDesign Server2025
API 20.5.0.49
Object

IndexingSortOption

An indexing sort option.

Hierarchy

Application | Document

IndexingSortOption

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
HeaderTypes | NothingEnum
+15 more
read/write The header type. Can return: HeaderTypes enumerator or NothingEnum enumerator.
Boolean read/write If true, include this indexing sort option.
Number readonly The index of the IndexingSortOption within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String readonly The name of the IndexingSortOption.
Application | Document readonly The parent of the IndexingSortOption (a Application or Document).
Number read/write Priority of this indexing sort option (shuffles prior entries down).
Object read/write A property that allows setting of several properties at the same time.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
IndexingSortOption[]

Resolves the object specifier, creating an array of object references.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Generates a string which, if executed, will return the IndexingSortOption.

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a IndexingSortOption.

Parameter of 3

Method parameters that accept a IndexingSortOption.

Return 12

Methods that return a IndexingSortOption.