Adobe InDesign CS6 (8.0) Object Model JS: TOCStyleEntry

InDesign CS6

Class

TOCStyleEntry

 A TOC entry definition.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

TOCStyle
TOCStyleEntry
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
formatStyleParagraphStyleString r/wThe paragraph style applied to the TOC entry. Can return: ParagraphStyle or String.
indexnumber readonlyThe index of the TOCStyleEntry within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
levelnumber r/wThe indent level of the entry in the TOC.
namestring r/wThe name of the TOCStyleEntry.
pageNumberPositionPageNumberPosition:
PageNumberPosition.AFTER_ENTRY
PageNumberPosition.BEFORE_ENTRY
PageNumberPosition.NONE
r/wThe page number placement for the TOC entry style.
pageNumberStyleCharacterStyle
String
r/wThe character style applied to the page number of the entry. Can return: CharacterStyle or String.
parentTOCStyle readonlyThe parent of the TOCStyleEntry (a TOCStyle).
propertiesObject r/wA property that allows setting of several properties at the same time.
separatorstring r/wThe string to insert between the entry text and the page numbers.
separatorStyleCharacterStyle
String
r/wThe character style applied to the string separating the TOC entry text and the page numbers. Can return: CharacterStyle or String.
sortAlphabetbool r/wIf true, sorts the entries alphabetically.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of TOCStyleEntry getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the TOCStyleEntry.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the TOCStyleEntry.

string toSpecifier ()
Retrieves the object specifier.

Used in:

TOCStyleEntry TOCStyleEntries.nextItem (obj: TOCStyleEntry)

TOCStyleEntry TOCStyleEntries.previousItem (obj: TOCStyleEntry)

Return

TOCStyleEntry TOCStyleEntries.[] (index: number)

TOCStyleEntry TOCStyleEntries.add ([styleName: string][, withProperties: Object])

TOCStyleEntry TOCStyleEntries.anyItem ()

Array of TOCStyleEntry TOCStyleEntries.everyItem ()

TOCStyleEntry TOCStyleEntries.firstItem ()

TOCStyleEntry TOCStyleEntries.item (index: varies)

TOCStyleEntry TOCStyleEntries.itemByName (name: string)

Array of TOCStyleEntry TOCStyleEntries.itemByRange (from: varies, to: varies)

TOCStyleEntry TOCStyleEntries.lastItem ()

TOCStyleEntry TOCStyleEntries.middleItem ()

TOCStyleEntry TOCStyleEntries.nextItem (obj: TOCStyleEntry)

TOCStyleEntry TOCStyleEntries.previousItem (obj: TOCStyleEntry)

Array of TOCStyleEntry TOCStyleEntry.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index