Adobe InDesign CS5.5 (7.5) Object Model JS: IndexSections

InDesign CS5.5

Class

IndexSections

 A collection of index sections.

See also IndexSection.

QuickLinks

[], anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

IndexSection [] (index: number)
Returns the IndexSection with the specified index.

ParameterTypeDescription
indexnumberThe index.

IndexSection anyItem ()
Returns any IndexSection in the collection.

number count ()
Displays the number of elements in the IndexSection.

Array of IndexSection everyItem ()
Returns every IndexSection in the collection.

IndexSection firstItem ()
Returns the first IndexSection in the collection.

IndexSection item (index: varies)
Returns the IndexSection with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

IndexSection itemByID (id: number)
Returns the IndexSection with the specified ID.

ParameterTypeDescription
idnumberThe ID.

IndexSection itemByName (name: string)
Returns the IndexSection with the specified name.

ParameterTypeDescription
namestringThe name.

Array of IndexSection itemByRange (from: varies, to: varies)
Returns the IndexSections within the specified range.

ParameterTypeDescription
fromIndexSection
Long Integer
String
The IndexSection, index, or name at the beginning of the range. Can accept: IndexSection, Long Integer or String.
toIndexSection
Long Integer
String
The IndexSection, index, or name at the end of the range. Can accept: IndexSection, Long Integer or String.

IndexSection lastItem ()
Returns the last IndexSection in the collection.

IndexSection middleItem ()
Returns the middle IndexSection in the collection.

IndexSection nextItem (obj: IndexSection)
Returns the IndexSection whose index follows the specified IndexSection in the collection.

ParameterTypeDescription
objIndexSectionThe IndexSection whose index comes before the desired IndexSection.

IndexSection previousItem (obj: IndexSection)
Returns the IndexSection with the index previous to the specified index.

ParameterTypeDescription
objIndexSectionThe index of the IndexSection that follows the desired IndexSection.

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

Element of

Index.indexSections

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