IndexOptions

Index generation and formatting options.

IndexOptions Properties

Property Type Access Description
beforeCrossReferenceSeparator String r/w The string following each index topic.
betweenEntriesSeparator String r/w The string between each index entry.
betweenPageNumbersSeparator String r/w The string between page numbers or page ranges.
crossReferenceStyle CharacterStyle r/w The style to apply to cross references.
crossReferenceTopicStyle CharacterStyle r/w The style to apply to cross reference topics.
entryEndSeparator String r/w The string to insert at the end of each index entry.
followingTopicSeparator String r/w The string following each index topic.
includeBookDocuments Boolean r/w If true, include index entries from all documents in the book.
includeEmptyIndexSections Boolean r/w If true, include headings for empty section(only valid when include section headings is also true).
includeHiddenEntries Boolean r/w If true, include text on hidden layers.
includeSectionHeadings Boolean r/w If true, include index section headings.
indexFormat IndexFormat enumeration r/w Specifies run-in or nested format.
level1Style ParagraphStyle r/w The style to apply to level 1 topics of each page reference.
level2Style ParagraphStyle r/w The style to apply to level 2 topics of each page reference.
level3Style ParagraphStyle r/w The style to apply to level 3 topics of each page reference.
level4Style ParagraphStyle r/w The style to apply to level 4 topics of each page reference.
pageNumberStyle CharacterStyle r/w The style to apply to page numbers.
pageRangeSeparator String r/w The string between page numbers to indicate a page range.
parent Object read The parent of the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
replaceExistingIndex Boolean r/w If true, replace the existing index.
sectionHeadingStyle ParagraphStyle r/w The style to apply to index section headings.
title String r/w The title.
titleStyle ParagraphStyle, String r/w The paragraph style of the title as ParagraphStyle or String.

IndexOptions Methods

Method Returns Description
getElements Array of Objects Resolve the object specifier.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: