Object

Index_

An index.

Hierarchy

Index_

Properties

Type	Access	Description
Topic[]	readonly	The topics in the specified index section.
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Number	readonly	The unique ID of the Index.
Number	readonly	The index of the Index within its containing object.
IndexSections<IndexSection>	readonly	A collection of index sections.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
String	read/write	The name of the Index; this is an alias to the Index's label property.
Document	readonly	The parent of the Index (a Document).
Object	read/write	A property that allows setting of several properties at the same time.
Topics<Topic>	readonly	A collection of index topics.

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.

→ void

Makes the initial letter for the specified index topic or group of index topics upper case.

capitalizationOption? IndexCapitalizationOptions The entry or entries to capitalize.

→ String

Gets the label value associated with the specified key.

key String The key.

→ Story[]

Generates a new index story.

on? Page | Spread | MasterSpread The spread or page on which to place the story. Can accept: Page, Spread or MasterSpread.

placePoint? Number[] | String[] unit The coordinates of the upper left corner of the story bounding box, in the format [x, y].

destinationLayer? Layer The layer on which to place the story.

autoflowing? Boolean If true, allows the story to flow onto subsequent pages if the story does not fit on the specified page. If no subsequent pages exist in the document, creates the necessary pages.

includeOverset? Boolean If true, includes topics in overset text in the story.

→ Index_[]

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

→ void

Imports a list of index topics.

from File The file from which to import the topics.

→ void

Sets the label to the value associated with the specified key.

key String The key.

value String The value.

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

→ void

Removes all index topics that do not have any index entries.

→ String

Generates a string which, if executed, will return the Index.

→ String

Retrieves the object specifier.

→ void

Updates the index preview pane. Note: Does not update the index.

Object of 2

Properties elsewhere that hold a Index_.

IndexSection.parent Topic.parent

Parameter of 2

Method parameters that accept a Index_.

Indexes.nextItem(obj)Indexes.previousItem(obj)

Return 14

Methods that return a Index_.

Index_.getElements()Indexes.[]()Indexes.add()Indexes.anyItem()Indexes.everyItem()Indexes.firstItem()Indexes.item()Indexes.itemByID()Indexes.itemByName()Indexes.itemByRange()Indexes.lastItem()Indexes.middleItem()Indexes.nextItem()Indexes.previousItem()