Adobe InDesign CS2 (4.0) Object Model JS: TOCStyleEntries

InDesign CS2

Class

TOCStyleEntries

 A collection TOC style entries.

QuickLinks

add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TOCStyleEntry add ([styleName: string][, withProperties: Object])
Adds a TOC style entry.

ParameterTypeDescription
styleNamestringThe paragraph style to include as TOC entries in the TOC. (Optional)
withPropertiesObjectInitial values for properties of the new TOCStyleEntry (Optional)

TOCStyleEntry anyItem ()
Returns any TOCStyleEntry in the collection.

number count ()
Displays the number of elements in the TOCStyleEntry.

Array of TOCStyleEntry everyItem ()
Returns every TOCStyleEntry in the collection.

TOCStyleEntry firstItem ()
Returns the first TOCStyleEntry in the collection.

TOCStyleEntry item (index: any)
Returns the TOCStyleEntry with the specified index or name.

ParameterTypeDescription
indexLong
String
The index or name. Can accept: Long or String.

TOCStyleEntry itemByName (name: string)
Returns the TOCStyleEntry with the specified name.

ParameterTypeDescription
namestringThe name.

Array of TOCStyleEntry itemByRange (from: any, to: any)
Returns the TOCStyleEntries within the specified range.

ParameterTypeDescription
fromLong
String
TOCStyleEntry
The TOCStyleEntry, index, or name at the beginning of the range. Can accept: TOCStyleEntry, Long or String.
toLong
String
TOCStyleEntry
The TOCStyleEntry, index, or name at the end of the range. Can accept: TOCStyleEntry, Long or String.

TOCStyleEntry lastItem ()
Returns the last TOCStyleEntry in the collection.

TOCStyleEntry middleItem ()
Returns the middle TOCStyleEntry in the collection.

TOCStyleEntry nextItem (obj: TOCStyleEntry)
Returns the TOCStyleEntry whose index follows the specified TOCStyleEntry in the collection.

ParameterTypeDescription
objTOCStyleEntryThe TOCStyleEntry whose index comes before the desired TOCStyleEntry.

TOCStyleEntry previousItem (obj: TOCStyleEntry)
Returns the TOCStyleEntry with the index previous to the specified index.

ParameterTypeDescription
objTOCStyleEntryThe index of the TOCStyleEntry that follows the desired TOCStyleEntry.

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

Element of

TOCStyle.tocStyleEntries

Jongware, 27-Jun-2010 v3.0.3dContents :: Index