Adobe InDesign CS4 (6.0) Object Model JS: IndexSection

InDesign CS4

Class

IndexSection

 A section within an index.

QuickLinks

extractLabel, getElements, insertLabel, toSource, toSpecifier

Hierarchy

Index
IndexSection
Topic

Properties

PropertyTypeAccessDescription
allTopicsArray of Topic readonlyThe topics in the specified index section.
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 readonlyA collection of index topics.

Methods

Instances

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.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of IndexSection IndexSections.itemByRange (from: any, to: any)

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

IndexSection IndexSections.itemByID (id: number)

IndexSection IndexSections.itemByName (name: string)

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

IndexSection IndexSections.lastItem ()

IndexSection IndexSections.middleItem ()

IndexSection IndexSections.nextItem (obj: IndexSection)

IndexSection IndexSections.previousItem (obj: IndexSection)

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