TOCStyles

A collection of TOC styles.

Methods

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

Parameter Type Description
withProperties Object Initial values for properties of the new TOCStyle (Optional)

TOCStyleanyItem ()
Returns any TOCStyle in the collection.

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

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

TOCStylefirstItem ()
Returns the first TOCStyle in the collection.

TOCStyleitem (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.

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

Parameter Type Description
id number The ID.

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

Parameter Type Description
name string The name.

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

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

TOCStylelastItem ()
Returns the last TOCStyle in the collection.

TOCStylemiddleItem ()
Returns the middle TOCStyle in the collection.

TOCStylenextItem (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.

TOCStylepreviousItem (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

Leave a Comment

Previous post:

Next post: