TOCStyles

A collection of TOC styles.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

TOCStyle [] (index:Number)

Returns the TOCStyle with the specified index.

Parameter	Type	Description
index	Number	The index.

TOCStyle add (withProperties:Object)

Creates a new TOCStyle.

Parameter	Type	Description
withProperties	Object	Initial 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.

TOCStyle everyItem ()

Returns every TOCStyle in the collection.

TOCStyle firstItem ()

Returns the first TOCStyle in the collection.

TOCStyle item (index:Varies LongInteger String)

Returns the TOCStyle with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

TOCStyle itemByID (id:Number)

Returns the TOCStyle with the specified ID.

Parameter	Type	Description
id	Number	The ID.

TOCStyle itemByName (name:String)

Returns the TOCStyle with the specified name.

Parameter	Type	Description
name	String	The name.

TOCStyle itemByRange (from:Varies LongInteger TOCStyle String, to:Varies LongInteger TOCStyle String)

Returns the TOCStyles within the specified range.

Parameter	Type	Description
from	LongInteger TOCStyle String	The TOCStyle, index, or name at the beginning of the range. Can accept: TOCStyle, Long Integer or String.
to	LongInteger TOCStyle String	The TOCStyle, index, or name at the end of the range. Can accept: TOCStyle, Long Integer or String.

Parameter

Type

Description

from

LongInteger

TOCStyle

String

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

LongInteger

TOCStyle

String

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.

Parameter	Type	Description
obj	TOCStyle	The TOCStyle whose index comes before the desired TOCStyle.

TOCStyle previousItem (obj:TOCStyle)

Returns the TOCStyle with the index previous to the specified index.

Parameter	Type	Description
obj	TOCStyle	The index of the TOCStyle that follows the desired TOCStyle.

String toSource ()

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

Object of

Document.tocStyles