TOCStyle

A TOC style definition.

Methods:

duplicate, extractLabel, insertLabel, remove

Objects:

Boolean, Number, Object, ParagraphStyle, String, TOCStyleEntries

Property Listing

Property

Type

Access

Description

id

Number

readonly

The unique ID of the TOCStyle.

includeBookDocuments

Boolean

read/write

If true, includes the entire book in the TOC. If false, includes only the TOC entries in the current document. Note: Valid when the current document is part of a book.

includeHidden

Boolean

read/write

If true, the TOC includes entries from text on hidden layers.

index

Number

readonly

The index of the TOCStyle within its containing object.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the TOCStyle.

parent

Application

Document

readonly

The parent of the TOCStyle (a Document or Application).

properties

Object

read/write

A property that allows setting of several properties at the same time.

runIn

Boolean

read/write

If true, the lowest-level TOC entries are placed on the same line as the previous entry.

title

String

read/write

The TOC title.

titleStyle

ParagraphStyle

read/write

The paragraph style applied to the TOC title.

tocStyleEntries

TOCStyleEntries TOCStyleEntry

readonly

A collection TOC style entries.

Method Listing

TOCStyle duplicate ()

Duplicates the TOCStyle.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

undefined insertLabel (key:String, value:String)

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

undefined remove ()

Deletes the TOCStyle.

Object of

TOCStyleEntry.parent

Return

TOCStyles.add()

TOCStyle.duplicate()