Adobe InDesign CS4 (6.0) Object Model JS: TOCStyleEntry

InDesign CS4

Class

TOCStyleEntry

 A TOC entry definition.

QuickLinks

getElements, remove, toSource, toSpecifier

Hierarchy

TOCStyle
TOCStyleEntry

Properties

PropertyTypeAccessDescription
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

Array of TOCStyleEntry getElements ()
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:

array of TOCStyleEntry TOCStyleEntries.itemByRange (from: any, to: any)

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: 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 ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index