InDesign2026
API 21.5.1.73
Object

Topic

An index topic.

Properties

NameType AccessDescription
CrossReferences<CrossReference> readonly A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The index of the Topic within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write The name of the Topic.
PageReferences<PageReference> readonly A collection of index page references.
Topic | Index_ | IndexSection readonly The parent of the Topic (a IndexSection, Topic or Index).
Object read/write A property that allows setting of several properties at the same time.
String read/write The string by which the topic is sorted instead of the topic name is not used. Note: The actual topic text, rather than the sort order text, appears in the index.
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.
→ Topic[]

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

→ void

Deletes the Topic.

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

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

→ String

Retrieves the object specifier.

Object of 9

Properties elsewhere that hold a Topic.

Parameter of 4

Method parameters that accept a Topic.

Return 13

Methods that return a Topic.