DictionaryPreference

User dictionary preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, ComposeUsing, EventListeners, Events, Object

Hierarchy:

Superclass: Preference

Class: DictionaryPreference

Property Listing

Property

Type

Access

Description

composition

ComposeUsing

ComposeUsing.BOTH

ComposeUsing.USE_DOCUMENT

ComposeUsing.USE_USER_DICTIONARY

read/write

The hyphenation exception list to use when composing text.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

mergeUserDictionary

Boolean

read/write

If true, merges the spelling and hyphenation exceptions lists in the external user dictionary with the lists stored within the document.

parent

Application

Document

readonly

The parent of the DictionaryPreference (a Application or Document).

properties

Object

read/write

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

recomposeWhenChanged

Boolean

read/write

If true, recomposes all stories when the compose using settings are changed, or when words are added to or removed from the user dictionary.

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)

DictionaryPreference 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 DictionaryPreference.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Application.dictionaryPreferences

Document.dictionaryPreferences

Return

DictionaryPreference.getElements()