Adobe InDesign CS6 (8.0) Object Model JS: IndexingSortOptions

InDesign CS6

Class

IndexingSortOptions

 A collection of indexing sort options.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

IndexingSortOption anyItem ()
Returns any IndexingSortOption in the collection.

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

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

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

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

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

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromIndexingSortOption
Long Integer
String
The IndexingSortOption, index, or name at the beginning of the range. Can accept: IndexingSortOption, Long Integer or String.
toIndexingSortOption
Long Integer
String
The IndexingSortOption, index, or name at the end of the range. Can accept: IndexingSortOption, Long Integer or String.

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

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

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

ParameterTypeDescription
objIndexingSortOptionThe IndexingSortOption whose index comes before the desired IndexingSortOption.

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

ParameterTypeDescription
objIndexingSortOptionThe index of the IndexingSortOption that follows the desired IndexingSortOption.

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

Element of

Application.indexingSortOptions

Document.indexingSortOptions

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