K4 InDesign Javascript API Documentation

Table Of_ContentsTOCStyle

A TOC style definition.

Instance Properties

Name Description Access
createBookmarks bool If true, creates bookmarks for TOC entries. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the TOCStyle. read-only
includeBookDocuments bool 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. read-write
includeHidden bool If true, the TOC includes entries from text on hidden layers. read-write
index number The index of the TOCStyle within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
makeAnchor bool If true, make text anchor in source paragraph. read-write
name string The name of the TOCStyle. read-write
numberedParagraphs NumberedParagraphsOptions The format for importing numbered paragraphs into the TOC. read-write
parent Document The parent of the TOCStyle (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
removeForcedLineBreak bool If true, remove forced line breaks. read-write
runIn bool If true, the lowest-level TOC entries are placed on the same line as the previous entry. read-write
setStoryDirection HorizontalOrVertical The table of contents story direction. read-write
title string The TOC title. read-write
titleStyle ParagraphStyle The paragraph style applied to the TOC title. read-write
tocStyleEntries TOCStyleEntries A collection TOC style entries. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → TOCStyle
extractLabel(
key)
  → string
getElements(
)
  → TOCStyle
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
duplicate(
)
  → TOCStyle
Duplicates the TOCStyle.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → TOCStyle
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the TOCStyle.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TOCStyle.
toSpecifier(
)
  → string
Retrieves the object specifier.