TOCStyleEntries
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
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.
Array
of TOCStyleEntry everyItem ()
Returns every TOCStyleEntry in the collection.
TOCStyleEntry firstItem ()
Returns the first TOCStyleEntry in the collection.
TOCStyleEntry item (index:
any)
Returns the TOCStyleEntry with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long String | The index or name. Can accept: Long or String. |
TOCStyleEntry itemByName (name:
string)
Returns the TOCStyleEntry with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of TOCStyleEntry itemByRange (from:
any, to:
any)
Returns the TOCStyleEntries within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long String TOCStyleEntry | The TOCStyleEntry, index, or name at the beginning of the range. Can accept: TOCStyleEntry, Long or String. |
| to | Long String TOCStyleEntry | The TOCStyleEntry, index, or name at the end of the range. Can accept: TOCStyleEntry, Long 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.
Element of
TOCStyle.tocStyleEntries
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |