K4 InDesign Javascript API Documentation

Table Of_ContentsTOCStyleEntry

A TOC entry definition.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
formatStyle The paragraph style applied to the TOC entry. Can return: ParagraphStyle or String. read-write
index number The index of the TOCStyleEntry within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
level number The indent level of the entry in the TOC. read-write
name string The name of the TOCStyleEntry. read-write
pageNumberPosition PageNumberPosition The page number placement for the TOC entry style. read-write
pageNumberStyle The character style applied to the page number of the entry. Can return: CharacterStyle or String. read-write
parent TOCStyle The parent of the TOCStyleEntry (a TOCStyle). read-only
properties Object A property that allows setting of several properties at the same time. read-write
separator string The string to insert between the entry text and the page numbers. read-write
separatorStyle The character style applied to the string separating the TOC entry text and the page numbers. Can return: CharacterStyle or String. read-write
sortAlphabet bool If true, sorts the entries alphabetically. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TOCStyleEntry
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)
getElements(
)
  → TOCStyleEntry
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the TOCStyleEntry.
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 TOCStyleEntry.
toSpecifier(
)
  → string
Retrieves the object specifier.