Adobe InDesign CS5 Server (7.0) Object Model JS: TOCStyles

InDesign Server CS5

Class

TOCStyles

 A collection of TOC styles.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TOCStyle [] (index: number)
Returns the TOCStyle with the specified index.

ParameterTypeDescription
indexnumberThe index.

TOCStyle add ([withProperties: Object])
Creates a new TOCStyle.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new TOCStyle (Optional)

TOCStyle anyItem ()
Returns any TOCStyle in the collection.

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

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

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

TOCStyle item (index: varies)
Returns the TOCStyle with the specified index or name.

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

TOCStyle itemByID (id: number)
Returns the TOCStyle with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

Array of TOCStyle itemByRange (from: varies, to: varies)
Returns the TOCStyles within the specified range.

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

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

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

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

ParameterTypeDescription
objTOCStyleThe TOCStyle whose index comes before the desired TOCStyle.

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

ParameterTypeDescription
objTOCStyleThe index of the TOCStyle that follows the desired TOCStyle.

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

Element of

Document.tocStyles

Jongware, 23-Mar-2011 v3.0.3dContents :: Index