InDesign Server2025
API 20.5.0.49
Object

TOCStyleEntry

A TOC entry definition.

Hierarchy

TOCStyle

TOCStyleEntry

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
ParagraphStyle | String read/write The paragraph style applied to the TOC entry. Can return: ParagraphStyle or String.
Number readonly The index of the TOCStyleEntry within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Number read/write The indent level of the entry in the TOC.
String read/write The name of the TOCStyleEntry.
PageNumberPosition
read/write The page number placement for the TOC entry style.
CharacterStyle | String read/write The character style applied to the page number of the entry. Can return: CharacterStyle or String.
TOCStyle readonly The parent of the TOCStyleEntry (a TOCStyle).
Object read/write A property that allows setting of several properties at the same time.
String read/write The string to insert between the entry text and the page numbers.
CharacterStyle | String read/write The character style applied to the string separating the TOC entry text and the page numbers. Can return: CharacterStyle or String.
Boolean read/write If true, sorts the entries alphabetically.

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.
TOCStyleEntry[]

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

void

Deletes the TOCStyleEntry.

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

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a TOCStyleEntry.

Parameter of 3

Method parameters that accept a TOCStyleEntry.

Return 13

Methods that return a TOCStyleEntry.