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

InDesign Server CS5

Class

IndexingSortOption

 An indexing sort option.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
IndexingSortOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
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.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
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

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

IndexingSortOption IndexingSortOptions.nextItem (obj: IndexingSortOption)

IndexingSortOption IndexingSortOptions.previousItem (obj: IndexingSortOption)

Return

Array of IndexingSortOption IndexingSortOption.getElements ()

IndexingSortOption IndexingSortOptions.[] (index: number)

IndexingSortOption IndexingSortOptions.anyItem ()

Array of IndexingSortOption IndexingSortOptions.everyItem ()

IndexingSortOption IndexingSortOptions.firstItem ()

IndexingSortOption IndexingSortOptions.item (index: varies)

IndexingSortOption IndexingSortOptions.itemByName (name: string)

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

IndexingSortOption IndexingSortOptions.lastItem ()

IndexingSortOption IndexingSortOptions.middleItem ()

IndexingSortOption IndexingSortOptions.nextItem (obj: IndexingSortOption)

IndexingSortOption IndexingSortOptions.previousItem (obj: IndexingSortOption)

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