TOCStyleEntry

A TOC entry definition.

Methods:

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, CharacterStyle, EventListeners, Events, Number, Object, PageNumberPosition, ParagraphStyle, String,

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

formatStyle

ParagraphStyle

String

read/write

The paragraph style applied to the TOC entry. Can return: ParagraphStyle or String.

index

Number

readonly

The index of the TOCStyleEntry within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

level

Number

read/write

The indent level of the entry in the TOC.

name

String

read/write

The name of the TOCStyleEntry.

pageNumberPosition

PageNumberPosition

PageNumberPosition.AFTER_ENTRY

PageNumberPosition.BEFORE_ENTRY

PageNumberPosition.NONE

read/write

The page number placement for the TOC entry style.

pageNumberStyle

CharacterStyle

String

read/write

The character style applied to the page number of the entry. Can return: CharacterStyle or String.

parent

TOCStyle

readonly

The parent of the TOCStyleEntry (a TOCStyle).

properties

Object

read/write

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

separator

String

read/write

The string to insert between the entry text and the page numbers.

separatorStyle

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.

sortAlphabet

Boolean

read/write

If true, sorts the entries alphabetically.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

TOCStyleEntry getElements ()

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

undefined remove ()

Deletes the TOCStyleEntry.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

TOCStyleEntries.add()

TOCStyleEntry.getElements()

TOCStyleEntries.anyItem()

TOCStyleEntries.everyItem()

TOCStyleEntries.itemByRange()

TOCStyleEntries.nextItem()

TOCStyleEntries.previousItem()

TOCStyleEntries.item()

TOCStyleEntries.[]()

TOCStyleEntries.itemByName()

TOCStyleEntries.firstItem()

TOCStyleEntries.lastItem()

TOCStyleEntries.middleItem()