Class
Index options. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
IndexOptions
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| beforeCrossReferenceSeparator | string | r/w | The character(s) inserted at the start of cross references. |
| betweenEntriesSeparator | string | r/w | The character(s) inserted between index entries when runin-style index format is used for nested topics. |
| betweenPageNumbersSeparator | string | r/w | The character(s) inserted between separate page numbers, page numbers and page ranges, and series of page ranges. |
| crossReferenceStyle | CharacterStyle | r/w | The character style applied to cross references. |
| crossReferenceTopicStyle | CharacterStyle | r/w | The character style applied to cross reference topics. |
| entryEndSeparator | string | r/w | The character(s) inserted at the end of each index entry. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| followingTopicSeparator | string | r/w | The character(s) inserted after each index topic. |
| includeBookDocuments | bool | r/w | If true, includes topics and page references from all the documents in a book. |
| includeEmptyIndexSections | bool | r/w | If true, displays headings for sections with no index topics. Note: Valid only when include section headings is true. |
| includeHiddenEntries | bool | r/w | If true, includes topics and page references on hidden layers. |
| includeSectionHeadings | bool | r/w | If true, displays the letters of the alphabet as index section headings. |
| indexFormat | IndexFormat: IndexFormat.RUNIN_FORMAT IndexFormat.NESTED_FORMAT |
r/w | The format for level 2 and lower index topics. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| level1Style | ParagraphStyle | r/w | The paragraph style applied to level 1 index topics. |
| level2Style | ParagraphStyle | r/w | The paragraph style applied to level 2 index topics. |
| level3Style | ParagraphStyle | r/w | The paragraph style applied to level 3 index topics. |
| level4Style | ParagraphStyle | r/w | The paragraph style applied to level 4 index topics. |
| pageNumberStyle | CharacterStyle | r/w | The character style applied to page numbers in the index. |
| pageRangeSeparator | string | r/w | 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 | r/w | A property that allows setting of several properties at the same time. |
| replaceExistingIndex | bool | r/w | 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 | r/w | The paragraph style applied to index section headings. Note: Valid when include section headings is true. |
| title | string | r/w | The title of the generated index. |
| titleStyle | ParagraphStyle String |
r/w | The 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.3d | Contents :: Index |