Class

TOCStyles

 A collection of TOC styles.

QuickLinks

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

Properties

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

Methods

Instances

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.

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

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

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

Parameter	Type	Description
index	Long Integer 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.

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

Parameter	Type	Description
from	Long Integer String TOCStyle	The TOCStyle, index, or name at the beginning of the range. Can accept: TOCStyle, Long Integer or String.
to	Long 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.

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.

Element of

Document.tocStyles

Jongware, 20-Jun-2010 v3.0.3d

Contents :: Index