TOCStyle

A table of contents style.

TOCStyle Properties

Property Type Access Description
createBookmarks Boolean r/w Whether to create bookmarks for TOC entries.
id Long read A unique number identifying the object.
includeBookDocuments Boolean r/w If the document this TOC style belongs to is in a book, whether to include TOC data from other book documents.
includeHidden Boolean r/w Whether to include text on hidden layers.
index Long read Index of the object within its parent object.
label String r/w A label that can be set to any string.
name String r/w The name of the object.
parent Object read The parent of the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
runIn Boolean r/w Whether the last levels of entries are run in.
setStoryDirection HorizontalOrVertical enumeration r/w Set table of content story direction.
title String r/w The title of the table of content to create.
titleStyle ParagraphStyle r/w The paragraph style TOC title is formatted to.
tocStyleEntries TOCStyleEntries read Every TOC style entry.

TOCStyle Methods

Method Returns Description
duplicate Object Duplicates the object.
extractLabel String Gets the content of the label associated with the specified key (name).
getElements Array of Objects Resolve the object specifier.
insertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
remove Nothing Delete the object.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: