IndexingSortOption

An indexing sort option.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, HeaderTypes, NothingEnum, Number, Object, String,

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

headerType

HeaderTypes

HeaderTypes.BASIC_LATIN

HeaderTypes.BELARUSIAN

HeaderTypes.BULGARIAN

HeaderTypes.CHINESE_PINYIN

HeaderTypes.CHINESE_STROKE_COUNT

HeaderTypes.CROATIAN

HeaderTypes.CZECH

HeaderTypes.DANISH_NORWEGIAN

HeaderTypes.ESTONIAN

HeaderTypes.FINNISH_SWEDISH

HeaderTypes.HIRAGANA_ALL

HeaderTypes.HIRAGANA_CONSONANTS_ONLY

HeaderTypes.HUNGARIAN

HeaderTypes.KATAKANA_ALL

HeaderTypes.KATAKANA_CONSONANTS_ONLY

HeaderTypes.KOREAN_CONSONANT

HeaderTypes.KOREAN_CONSONANT_PLUS_VOWEL

HeaderTypes.LATVIAN

HeaderTypes.LITHUANIAN

HeaderTypes.POLISH

HeaderTypes.ROMANIAN

HeaderTypes.RUSSIAN

HeaderTypes.SLOVAK

HeaderTypes.SLOVENIAN

HeaderTypes.SPANISH

HeaderTypes.TURKISH

HeaderTypes.UKRAINIAN

NothingEnum.NOTHING

read/write

The header type. Can return: HeaderTypes enumerator or NothingEnum enumerator.

include

Boolean

read/write

If true, include this indexing sort option.

index

Number

readonly

The index of the IndexingSortOption within its containing object.

isValid

Boolean

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

read/write

Priority of this indexing sort option (shuffles prior entries down).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

IndexingSortOption getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

IndexingSortOption.getElements()

IndexingSortOptions.anyItem()

IndexingSortOptions.everyItem()

IndexingSortOptions.nextItem()

IndexingSortOptions.previousItem()

IndexingSortOptions.item()

IndexingSortOptions.[]()

IndexingSortOptions.itemByName()

IndexingSortOptions.itemByRange()

IndexingSortOptions.firstItem()

IndexingSortOptions.lastItem()

IndexingSortOptions.middleItem()