TOCStyleEntries

A collection TOC style entries.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, 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

TOCStyleEntry [] (index:Number)

Returns the TOCStyleEntry with the specified index.

Parameter	Type	Description
index	Number	The index.

TOCStyleEntry add (styleName:String, withProperties:Object)

Adds a TOC style entry.

Parameter	Type	Description
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)

TOCStyleEntry anyItem ()

Returns any TOCStyleEntry in the collection.

Number count ()

Displays the number of elements in the TOCStyleEntry.

TOCStyleEntry everyItem ()

Returns every TOCStyleEntry in the collection.

TOCStyleEntry firstItem ()

Returns the first TOCStyleEntry in the collection.

TOCStyleEntry item (index:Varies LongInteger String)

Returns the TOCStyleEntry 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.

TOCStyleEntry itemByName (name:String)

Returns the TOCStyleEntry with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the TOCStyleEntries within the specified range.

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

Parameter

Type

Description

from

LongInteger

TOCStyleEntry

String

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

LongInteger

TOCStyleEntry

String

The TOCStyleEntry, index, or name at the end of the range. Can accept: TOCStyleEntry, Long Integer 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.

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

TOCStyleEntry previousItem (obj:TOCStyleEntry)

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

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

String toSource ()

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

Object of

TOCStyle.tocStyleEntries