InDesign Server2025
API 20.5.0.49
Collection of TOCStyleEntry

TOCStyleEntries

A collection TOC style entries.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

TOCStyleEntry

Returns the TOCStyleEntry with the specified index.

index Number The index.
TOCStyleEntry

Adds a TOC style entry.

styleName? String The paragraph style to include as TOC entries in the TOC.
withProperties? Object Initial values for properties of the new TOCStyleEntry
TOCStyleEntry

Returns any TOCStyleEntry in the collection.

Number

Displays the number of elements in the TOCStyleEntry.

TOCStyleEntry[]

Returns every TOCStyleEntry in the collection.

TOCStyleEntry

Returns the first TOCStyleEntry in the collection.

TOCStyleEntry

Returns the TOCStyleEntry with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
TOCStyleEntry

Returns the TOCStyleEntry with the specified name.

name String The name.
TOCStyleEntry[]

Returns the TOCStyleEntries within the specified range.

from LongInteger | TOCStyleEntry | String The TOCStyleEntry, index, or name at the beginning of the range. Can accept: TOCStyleEntry, Long Integer or String.
to LongInteger | TOCStyleEntry | String The TOCStyleEntry, index, or name at the end of the range. Can accept: TOCStyleEntry, Long Integer or String.
TOCStyleEntry

Returns the last TOCStyleEntry in the collection.

TOCStyleEntry

Returns the middle TOCStyleEntry in the collection.

TOCStyleEntry

Returns the TOCStyleEntry whose index follows the specified TOCStyleEntry in the collection.

obj TOCStyleEntry The TOCStyleEntry whose index comes before the desired TOCStyleEntry.
TOCStyleEntry

Returns the TOCStyleEntry with the index previous to the specified index.

obj TOCStyleEntry The index of the TOCStyleEntry that follows the desired TOCStyleEntry.
String

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

Object of 1

Properties elsewhere that hold a TOCStyleEntries.