IndexOptions

Index options.

Go to Property Listing | Method Listing

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy:

Class: IndexOptions

Property Listing

Property	Type	Access	Description
beforeCrossReferenceSeparator	String	read/write	The character(s) inserted at the start of cross references.
betweenEntriesSeparator	String	read/write	The character(s) inserted between index entries when runin-style index format is used for nested topics.
betweenPageNumbersSeparator	String	read/write	The character(s) inserted between separate page numbers, page numbers and page ranges, and series of page ranges.
crossReferenceStyle	CharacterStyle	read/write	The character style applied to cross references.
crossReferenceTopicStyle	CharacterStyle	read/write	The character style applied to cross reference topics.
entryEndSeparator	String	read/write	The character(s) inserted at the end of each index entry.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
followingTopicSeparator	String	read/write	The character(s) inserted after each index topic.
includeBookDocuments	Boolean	read/write	If true, includes topics and page references from all the documents in a book.
includeEmptyIndexSections	Boolean	read/write	If true, displays headings for sections with no index topics. Note: Valid only when include section headings is true.
includeHiddenEntries	Boolean	read/write	If true, includes topics and page references on hidden layers.
includeSectionHeadings	Boolean	read/write	If true, displays the letters of the alphabet as index section headings.
indexFormat	IndexFormat IndexFormat.NESTED_FORMAT IndexFormat.RUNIN_FORMAT	read/write	The format for level 2 and lower index topics.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
level1Style	ParagraphStyle	read/write	The paragraph style applied to level 1 index topics.
level2Style	ParagraphStyle	read/write	The paragraph style applied to level 2 index topics.
level3Style	ParagraphStyle	read/write	The paragraph style applied to level 3 index topics.
level4Style	ParagraphStyle	read/write	The paragraph style applied to level 4 index topics.
pageNumberStyle	CharacterStyle	read/write	The character style applied to page numbers in the index.
pageRangeSeparator	String	read/write	The character(s) inserted between page numbers to indicate a page range.
parent	Application Document	readonly	The parent of the IndexOptions (a Document or Application).
properties	Object	read/write	A property that allows setting of several properties at the same time.
replaceExistingIndex	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.
sectionHeadingStyle	ParagraphStyle	read/write	The paragraph style applied to index section headings. Note: Valid when include section headings is true.
title	String	read/write	The title of the generated index.
titleStyle	ParagraphStyle String	read/write	The paragraph style applied to the title of the generated index. Can also accept: String.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

IndexOptions getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
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. (Optional) (default: false)