Adobe InDesign CS5.5 (7.5) Object Model JS: TOCStyle

InDesign CS5.5

previous page next page

Class

TOCStyle

A TOC style definition.

QuickLinks

addEventListener, duplicate, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Document

TOCStyle

Event | EventListener | MutationEvent | TOCStyleEntry

Properties

Property	Type	Access	Description
createBookmarks	bool	r/w	If true, creates bookmarks for TOC entries.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the TOCStyle.
includeBookDocuments	bool	r/w	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	bool	r/w	If true, the TOC includes entries from text on hidden layers.
index	number	readonly	The index of the TOCStyle within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the TOCStyle.
numberedParagraphs	NumberedParagraphsOptions: NumberedParagraphsOptions.INCLUDE_FULL_PARAGRAPH NumberedParagraphsOptions.INCLUDE_NUMBERS_ONLY NumberedParagraphsOptions.EXCLUDE_NUMBERS	r/w	The format for importing numbered paragraphs into the TOC.
parent	Document	readonly	The parent of the TOCStyle (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
runIn	bool	r/w	If true, the lowest-level TOC entries are placed on the same line as the previous entry.
setStoryDirection	HorizontalOrVertical: HorizontalOrVertical.HORIZONTAL HorizontalOrVertical.VERTICAL	r/w	The table of contents story direction.
title	string	r/w	The TOC title.
titleStyle	ParagraphStyle	r/w	The paragraph style applied to the TOC title.
tocStyleEntries	TOCStyleEntries TOCStyleEntry	readonly	A collection TOC style entries.

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)

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.

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

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

void remove ()
Deletes the TOCStyle.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

TOCStyleEntry.parent

Used in:

array of Story Document.createTOC (using: TOCStyle[, replacing: bool=false][, fromBook: Book][, placePoint: Array of Measurement Unit (Number or String)][, includeOverset: bool=false][, destinationLayer: Layer])