IndexingSortOption
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| headerType | HeaderTypesNothingEnum | r/w | The header type. Can return: HeaderTypes enumerator or NothingEnum enumerator. |
| include | bool | r/w | If true, include this indexing sort option. |
| index | number | readonly | The index of the IndexingSortOption within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| name | string | readonly | The name of the IndexingSortOption. |
| parent | Application Document |
readonly | The parent of the IndexingSortOption (a Application or Document). |
| priority | number | r/w | Priority of this indexing sort option (shuffles prior entries down). |
| properties | Object | r/w | A 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the IndexingSortOption.
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, 29-Apr-2012 v3.0.3i | Contents :: Index |