A collection TOC style entries.
Methods
TOCStyleEntryadd ([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) |
TOCStyleEntryanyItem ()
Returns any TOCStyleEntry in the collection.
number count ()
Displays the number of elements in the TOCStyleEntry.
Array of TOCStyleEntryeveryItem ()
Returns every TOCStyleEntry in the collection.
TOCStyleEntryfirstItem ()
Returns the first TOCStyleEntry in the collection.
TOCStyleEntryitem (index:
any)
Returns the TOCStyleEntry with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
TOCStyleEntryitemByName (name:
string)
Returns the TOCStyleEntry with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of TOCStyleEntryitemByRange (from:
any, to:
any)
Returns the TOCStyleEntries within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | TOCStyleEntry Long Integer String |
The TOCStyleEntry, index, or name at the beginning of the range. Can accept: TOCStyleEntry, Long Integer or String. |
| to | TOCStyleEntry Long Integer String |
The TOCStyleEntry, index, or name at the end of the range. Can accept: TOCStyleEntry, Long Integer or String. |
TOCStyleEntrylastItem ()
Returns the last TOCStyleEntry in the collection.
TOCStyleEntrymiddleItem ()
Returns the middle TOCStyleEntry in the collection.
TOCStyleEntrynextItem (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. |
TOCStyleEntrypreviousItem (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.
Element of:
TOCStyle.tocStyleEntries