Class

TOCStyleEntry

 A TOC entry definition.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

TOCStyle

TOCStyleEntry

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
formatStyle	ParagraphStyleString	r/w	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	bool	readonly	Returns true if the object specifier resolves to valid objects.
level	number	r/w	The indent level of the entry in the TOC.
name	string	r/w	The name of the TOCStyleEntry.
pageNumberPosition	PageNumberPosition: PageNumberPosition.AFTER_ENTRY PageNumberPosition.BEFORE_ENTRY PageNumberPosition.NONE	r/w	The page number placement for the TOC entry style.
pageNumberStyle	CharacterStyle String	r/w	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	r/w	A property that allows setting of several properties at the same time.
separator	string	r/w	The string to insert between the entry text and the page numbers.
separatorStyle	CharacterStyle String	r/w	The character style applied to the string separating the TOC entry text and the page numbers. Can return: CharacterStyle or String.
sortAlphabet	bool	r/w	If true, sorts the entries alphabetically.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of TOCStyleEntry getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the TOCStyleEntry.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	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.

Used in:

TOCStyleEntry TOCStyleEntries.nextItem (obj: TOCStyleEntry)

TOCStyleEntry TOCStyleEntries.previousItem (obj: TOCStyleEntry)

Return

TOCStyleEntry TOCStyleEntries.[] (index: number)

TOCStyleEntry TOCStyleEntries.add ([styleName: string][, withProperties: Object])

TOCStyleEntry TOCStyleEntries.anyItem ()

Array of TOCStyleEntry TOCStyleEntries.everyItem ()

TOCStyleEntry TOCStyleEntries.firstItem ()

TOCStyleEntry TOCStyleEntries.item (index: varies)

TOCStyleEntry TOCStyleEntries.itemByName (name: string)

Array of TOCStyleEntry TOCStyleEntries.itemByRange (from: varies, to: varies)

TOCStyleEntry TOCStyleEntries.lastItem ()

TOCStyleEntry TOCStyleEntries.middleItem ()

TOCStyleEntry TOCStyleEntries.nextItem (obj: TOCStyleEntry)

TOCStyleEntry TOCStyleEntries.previousItem (obj: TOCStyleEntry)

Array of TOCStyleEntry TOCStyleEntry.getElements ()

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index