Adobe InDesign CS5 Server (7.0) Object Model JS: Indexes

InDesign Server CS5

Class

Indexes

 A collection of indexes.

QuickLinks

[], add, 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

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

ParameterTypeDescription
indexnumberThe index.

Index add ([withProperties: Object])
Creates a new Index.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new Index (Optional)

Index anyItem ()
Returns any Index in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromIndex
Long Integer
String
The Index, index, or name at the beginning of the range. Can accept: Index, Long Integer or String.
toIndex
Long Integer
String
The Index, index, or name at the end of the range. Can accept: Index, Long Integer or String.

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

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

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

ParameterTypeDescription
objIndexThe Index whose index comes before the desired Index.

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

ParameterTypeDescription
objIndexThe index of the Index that follows the desired Index.

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

Element of

Document.indexes

Jongware, 23-Mar-2011 v3.0.3dContents :: Index