Adobe InDesign CS3 (5.0) Object Model JS: IndexingSortOption

InDesign CS3

Class

IndexingSortOption

 An indexing sort option.

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

Application | Document
IndexingSortOption

Properties

PropertyTypeAccessDescription
headerTypeHeaderTypesNothingEnum r/wThe header type. Can return: HeaderTypes enumerator or NothingEnum enumerator.
includebool r/wIf true, include this indexing sort option.
indexnumber readonlyThe index of the IndexingSortOption within its containing object.
namestring readonlyThe name of the IndexingSortOption.
parentApplication
Document
readonlyThe parent of the IndexingSortOption (a Application or Document).
prioritynumber r/wPriority of this indexing sort option (shuffles prior entries down).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of IndexingSortOption IndexingSortOptions.itemByRange (from: any, to: any)

IndexingSortOption IndexingSortOptions.nextItem (obj: IndexingSortOption)

IndexingSortOption IndexingSortOptions.previousItem (obj: IndexingSortOption)

Return

Array of IndexingSortOption IndexingSortOption.getElements ()

IndexingSortOption IndexingSortOptions.anyItem ()

Array of IndexingSortOption IndexingSortOptions.everyItem ()

IndexingSortOption IndexingSortOptions.firstItem ()

IndexingSortOption IndexingSortOptions.item (index: any)

IndexingSortOption IndexingSortOptions.itemByName (name: string)

Array of IndexingSortOption IndexingSortOptions.itemByRange (from: any, to: any)

IndexingSortOption IndexingSortOptions.lastItem ()

IndexingSortOption IndexingSortOptions.middleItem ()

IndexingSortOption IndexingSortOptions.nextItem (obj: IndexingSortOption)

IndexingSortOption IndexingSortOptions.previousItem (obj: IndexingSortOption)

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