Class
TOCStyle |
| | A TOC style definition. |
QuickLinks |
duplicate, extractLabel, insertLabel, remove |
Hierarchy
|
|
Properties
| | Property | Type | Access | Description |
|---|
| id | number |
readonly | The unique ID of the TOCStyle. |
| includeBookDocuments | bool |
r/w | If true, includes the entire book in the TOC. If false, includes only the TOC entries in the current document. Note: Valid when the current document is part of a book. |
| includeHidden | bool |
r/w | If true, the TOC includes entries from text on hidden layers. |
| index | number |
readonly | The index of the TOCStyle within its containing object. |
| label | string |
r/w | A property that can be set to any string. |
| name | string |
r/w | The name of the TOCStyle. |
| parent | ApplicationDocument |
readonly | The parent of the TOCStyle (a Document or Application). |
| properties | Object |
r/w | A property that allows setting of several properties at the same time. |
| runIn | bool |
r/w | If true, the lowest-level TOC entries are placed on the same line as the previous entry. |
| title | string |
r/w | The TOC title. |
| titleStyle | ParagraphStyle |
r/w | The paragraph style applied to the TOC title. |
| tocStyleEntries | TOCStyleEntries |
readonly | A collection TOC style entries. |
|
Methods
| InstancesTOCStyle duplicate ()
Duplicates the TOCStyle.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|
| key | string | The key. |
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the TOCStyle.
|
Element of |
TOCStyleEntry.parent
|
Used in: | TextFrame Document.createTOC
(using:
TOCStyle[, replacing:
bool=false][, fromBook:
Book][, placePoint:
Array
of Measurement Unit (Number or String)][, includeOverset:
bool=false][, destinationLayer:
Layer])
|
Return |
TOCStyle TOCStyle.duplicate ()
TOCStyle TOCStyles.add ([withProperties:
Object])
|