TOCStyle

A TOC style definition.

Properties

Property	Type	Access	Description
createBookmarks	bool	r/w	If true, creates bookmarks for TOC entries.
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.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the TOCStyle.
numberedParagraphs	NumberedParagraphsOptions : INCLUDE_FULL_PARAGRAPH INCLUDE_NUMBERS_ONLY 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 : HORIZONTAL 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	readonly	A collection TOC style entries.

Methods

TOCStyleduplicate ()
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 TOCStylegetElements ()
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.

string toSource ()
Generates a string which, if executed, will return the TOCStyle.

string toSpecifier ()
Retrieves the object specifier.

Element of:

TOCStyleEntry.parent

Used in:

Document.createTOC (

using:
TOCStyle [, replacing:
bool=false ][, fromBook:
Book][, placePoint:
Array of number][, includeOverset:
bool=false ][, destinationLayer:
Layer])

TOCStyles.previousItem (

obj:
TOCStyle )

TOCStyles.nextItem (

obj:
TOCStyle )

Returned by:

TOCStyle TOCStyle .duplicate (

)

Array of TOCStyle TOCStyle .getElements (

)

TOCStyle TOCStyles.add (
[withProperties:
Object]
)

TOCStyle TOCStyles.anyItem (

)

Array of TOCStyle TOCStyles.everyItem (

)

TOCStyle TOCStyles.firstItem (

)

TOCStyle TOCStyles.item (
index:
any
)

TOCStyle TOCStyles.itemByID (
id:
number
)

TOCStyle TOCStyles.itemByName (
name:
string
)

Array of TOCStyle TOCStyles.itemByRange (
from:
any, to:
any
)

TOCStyle TOCStyles.lastItem (

)

TOCStyle TOCStyles.middleItem (

)

TOCStyle TOCStyles.nextItem (
obj:
TOCStyle
)

TOCStyle TOCStyles.previousItem (
obj:
TOCStyle
)