Object

IndexOptions

Index options.

Preference ›IndexOptions

Hierarchy

IndexOptions

Properties

Type	Access	Description
String	read/write	The character(s) inserted at the start of cross references.
String	read/write	The character(s) inserted between index entries when runin-style index format is used for nested topics.
String	read/write	The character(s) inserted between separate page numbers, page numbers and page ranges, and series of page ranges.
CharacterStyle	read/write	The character style applied to cross references.
CharacterStyle	read/write	The character style applied to cross reference topics.
String	read/write	The character(s) inserted at the end of each index entry.
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
String	read/write	The character(s) inserted after each index topic.
Boolean	read/write	If true, includes topics and page references from all the documents in a book.
Boolean	read/write	If true, displays headings for sections with no index topics. Note: Valid only when include section headings is true.
Boolean	read/write	If true, includes topics and page references on hidden layers.
Boolean	read/write	If true, displays the letters of the alphabet as index section headings.
IndexFormat	read/write	The format for level 2 and lower index topics.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
ParagraphStyle	read/write	The paragraph style applied to level 1 index topics.
ParagraphStyle	read/write	The paragraph style applied to level 2 index topics.
ParagraphStyle	read/write	The paragraph style applied to level 3 index topics.
ParagraphStyle	read/write	The paragraph style applied to level 4 index topics.
CharacterStyle	read/write	The character style applied to page numbers in the index.
String	read/write	The character(s) inserted between page numbers to indicate a page range.
Application \| Document	readonly	The parent of the IndexOptions (a Document or Application).
Object	read/write	A property that allows setting of several properties at the same time.
Boolean	read/write	If true, replaces the content of the existing index. Note: Replaces only index content; does not update the index location or other index properties that may have been changed.
ParagraphStyle	read/write	The paragraph style applied to index section headings. Note: Valid when include section headings is true.
String	read/write	The title of the generated index.
ParagraphStyle \| String	read/write	The paragraph style applied to the title of the generated index. Can also accept: String.

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.

→ IndexOptions[]

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 IndexOptions.

→ String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a IndexOptions.

Application.indexGenerationOptions Document.indexGenerationOptions Event.parent EventListener.parent MutationEvent.parent

Return 1

Methods that return a IndexOptions.

IndexOptions.getElements()