K4 InDesign Javascript API Documentation

Table Of_ContentsTOCStyleEntries

A collection TOC style entries.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[styleName] ​[, withProperties])
  → TOCStyleEntry
anyItem(
)
  → TOCStyleEntry
count(
)
  → number
everyItem(
)
  → TOCStyleEntry
firstItem(
)
  → TOCStyleEntry
item(
index)
  → TOCStyleEntry
itemByName(
name)
  → TOCStyleEntry
itemByRange(
from, to)
  → TOCStyleEntry
lastItem(
)
  → TOCStyleEntry
middleItem(
)
  → TOCStyleEntry
nextItem(
obj)
  → TOCStyleEntry
previousItem(
obj)
  → TOCStyleEntry
toSource(
)
  → string
add(
[styleName] ​[, withProperties])
  → TOCStyleEntry
Adds a TOC style entry.
styleName string The paragraph style to include as TOC entries in the TOC. (Optional)
withProperties Object Initial values for properties of the new TOCStyleEntry (Optional)
anyItem(
)
  → TOCStyleEntry
Returns any TOCStyleEntry in the collection.
count(
)
  → number
Displays the number of elements in the TOCStyleEntry.
everyItem(
)
  → TOCStyleEntry
Returns every TOCStyleEntry in the collection.
firstItem(
)
  → TOCStyleEntry
Returns the first TOCStyleEntry in the collection.
item(
index)
  → TOCStyleEntry
Returns the TOCStyleEntry with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByName(
name)
  → TOCStyleEntry
Returns the TOCStyleEntry with the specified name.
name string The name.
itemByRange(
from, to)
  → TOCStyleEntry
Returns the TOCStyleEntries within the specified range.
from The TOCStyleEntry, index, or name at the beginning of the range. Can accept: TOCStyleEntry, Long Integer or String.
to The TOCStyleEntry, index, or name at the end of the range. Can accept: TOCStyleEntry, Long Integer or String.
lastItem(
)
  → TOCStyleEntry
Returns the last TOCStyleEntry in the collection.
middleItem(
)
  → TOCStyleEntry
Returns the middle TOCStyleEntry in the collection.
nextItem(
obj)
  → TOCStyleEntry
Returns the TOCStyleEntry whose index follows the specified TOCStyleEntry in the collection.
obj TOCStyleEntry The TOCStyleEntry whose index comes before the desired TOCStyleEntry.
previousItem(
obj)
  → TOCStyleEntry
Returns the TOCStyleEntry with the index previous to the specified index.
obj TOCStyleEntry The index of the TOCStyleEntry that follows the desired TOCStyleEntry.
toSource(
)
  → string
Generates a string which, if executed, will return the TOCStyleEntry.