A TOC entry definition.
Go to Property Listing | Method Listing
addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier
Boolean, CharacterStyle, EventListeners, Events, Number, Object, PageNumberPosition, ParagraphStyle, String,
Property |
Type |
Access |
Description |
---|---|---|---|
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
read/write |
The paragraph style applied to the TOC entry. Can return: ParagraphStyle or String. |
||
readonly |
The index of the TOCStyleEntry within its containing object. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
The indent level of the entry in the TOC. |
||
read/write |
The name of the TOCStyleEntry. |
||
read/write |
The page number placement for the TOC entry style. |
||
read/write |
The character style applied to the page number of the entry. Can return: CharacterStyle or String. |
||
readonly |
The parent of the TOCStyleEntry (a TOCStyle). |
||
read/write |
A property that allows setting of several properties at the same time. |
||
read/write |
The string to insert between the entry text and the page numbers. |
||
read/write |
The character style applied to the string separating the TOC entry text and the page numbers. Can return: CharacterStyle or String. |
||
read/write |
If true, sorts the entries alphabetically. |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
TOCStyleEntry getElements ()
Resolves the object specifier, creating an array of object references.
undefined remove ()
Deletes the TOCStyleEntry.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the TOCStyleEntry.
String toSpecifier ()
Retrieves the object specifier.