Adobe InDesign CS5 (7.0) Object Model JS: IndexOptions

InDesign CS5

Class

IndexOptions

 Index options. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
IndexOptions
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
beforeCrossReferenceSeparatorstring r/wThe character(s) inserted at the start of cross references.
betweenEntriesSeparatorstring r/wThe character(s) inserted between index entries when runin-style index format is used for nested topics.
betweenPageNumbersSeparatorstring r/wThe character(s) inserted between separate page numbers, page numbers and page ranges, and series of page ranges.
crossReferenceStyleCharacterStyle r/wThe character style applied to cross references.
crossReferenceTopicStyleCharacterStyle r/wThe character style applied to cross reference topics.
entryEndSeparatorstring r/wThe character(s) inserted at the end of each index entry.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
followingTopicSeparatorstring r/wThe character(s) inserted after each index topic.
includeBookDocumentsbool r/wIf true, includes topics and page references from all the documents in a book.
includeEmptyIndexSectionsbool r/wIf true, displays headings for sections with no index topics. Note: Valid only when include section headings is true.
includeHiddenEntriesbool r/wIf true, includes topics and page references on hidden layers.
includeSectionHeadingsbool r/wIf true, displays the letters of the alphabet as index section headings.
indexFormatIndexFormat:
IndexFormat.RUNIN_FORMAT
IndexFormat.NESTED_FORMAT
r/wThe format for level 2 and lower index topics.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
level1StyleParagraphStyle r/wThe paragraph style applied to level 1 index topics.
level2StyleParagraphStyle r/wThe paragraph style applied to level 2 index topics.
level3StyleParagraphStyle r/wThe paragraph style applied to level 3 index topics.
level4StyleParagraphStyle r/wThe paragraph style applied to level 4 index topics.
pageNumberStyleCharacterStyle r/wThe character style applied to page numbers in the index.
pageRangeSeparatorstring r/wThe character(s) inserted between page numbers to indicate a page range.
parentApplication
Document
readonlyThe parent of the IndexOptions (a Document or Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
replaceExistingIndexbool r/wIf 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.
sectionHeadingStyleParagraphStyle r/wThe paragraph style applied to index section headings. Note: Valid when include section headings is true.
titlestring r/wThe title of the generated index.
titleStyleParagraphStyle
String
r/wThe paragraph style applied to the title of the generated index. Can also accept: String.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of IndexOptions getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the IndexOptions.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.indexGenerationOptions

Document.indexGenerationOptions

Return

Array of IndexOptions IndexOptions.getElements ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index