Adobe InDesign CS6 Server (8.0) Object Model JS: IndexSection

InDesign Server CS6

Class

IndexSection

 A section within an index.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Hierarchy

Index
IndexSection
Event | EventListener | MutationEvent | Topic

Properties

PropertyTypeAccessDescription
allTopicsArray of Topic readonlyThe topics in the specified index section.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the IndexSection.
indexnumber readonlyThe index of the IndexSection within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the IndexSection.
parentIndex readonlyThe parent of the IndexSection (a Index).
propertiesObject r/wA property that allows setting of several properties at the same time.
topicsTopics Topic readonlyA collection of index topics.

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)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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 IndexSection.

string toSpecifier ()
Retrieves the object specifier.

Used in:

IndexSection IndexSections.nextItem (obj: IndexSection)

IndexSection IndexSections.previousItem (obj: IndexSection)

Return

Array of IndexSection IndexSection.getElements ()

IndexSection IndexSections.[] (index: number)

IndexSection IndexSections.anyItem ()

Array of IndexSection IndexSections.everyItem ()

IndexSection IndexSections.firstItem ()

IndexSection IndexSections.item (index: varies)

IndexSection IndexSections.itemByID (id: number)

IndexSection IndexSections.itemByName (name: string)

Array of IndexSection IndexSections.itemByRange (from: varies, to: varies)

IndexSection IndexSections.lastItem ()

IndexSection IndexSections.middleItem ()

IndexSection IndexSections.nextItem (obj: IndexSection)

IndexSection IndexSections.previousItem (obj: IndexSection)

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