A TOC entry definition.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| formatStyle | ParagraphStyle | r/w | The paragraph style applied to the TOC entry. |
| index | number | readonly | The index of the TOCStyleEntry within its containing object. |
| level | number | r/w | The indent level of the entry in the TOC. |
| name | string | r/w | The name of the TOCStyleEntry. |
| pageNumberPosition | PageNumberPosition : AFTER_ENTRY BEFORE_ENTRY NONE |
r/w | The page number placement for the TOC entry style. |
| pageNumberStyle | CharacterStyle | r/w | The character style applied to the page number of the entry. |
| parent | TOCStyle | readonly | The parent of the TOCStyleEntry (a TOCStyle). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| separator | string | r/w | The string to insert between the entry text and the page numbers. |
| separatorStyle | CharacterStyle | r/w | The character style applied to the string separating the TOC entry text and the page numbers. |
| sortAlphabet | bool | r/w | If true, sorts the entries alphabetically. |
Methods
Array of TOCStyleEntrygetElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the TOCStyleEntry.
string toSource ()
Generates a string which, if executed, will return the TOCStyleEntry.
string toSpecifier ()
Retrieves the object specifier.
Used in:
TOCStyleEntries.previousItem (
obj:
TOCStyleEntry )
TOCStyleEntries.nextItem (
obj:
TOCStyleEntry )
Returned by:
TOCStyleEntry TOCStyleEntries.add (
[styleName:
string][, withProperties:
Object]
)
TOCStyleEntry TOCStyleEntries.anyItem (
)
Array of TOCStyleEntry TOCStyleEntries.everyItem (
)
TOCStyleEntry TOCStyleEntries.firstItem (
)
TOCStyleEntry TOCStyleEntries.item (
index:
any
)
TOCStyleEntry TOCStyleEntries.itemByName (
name:
string
)
Array of TOCStyleEntry TOCStyleEntries.itemByRange (
from:
any, to:
any
)
TOCStyleEntry TOCStyleEntries.lastItem (
)
TOCStyleEntry TOCStyleEntries.middleItem (
)
TOCStyleEntry TOCStyleEntries.nextItem (
obj:
TOCStyleEntry
)
TOCStyleEntry TOCStyleEntries.previousItem (
obj:
TOCStyleEntry
)
Array of TOCStyleEntry TOCStyleEntry .getElements (
)