Class
User dictionary preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
DictionaryPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| composition | ComposeUsing: ComposeUsing.USE_USER_DICTIONARY ComposeUsing.USE_DOCUMENT ComposeUsing.BOTH |
r/w | The hyphenation exception list to use when composing text. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| mergeUserDictionary | bool | r/w | 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 | r/w | A property that allows setting of several properties at the same time. |
| recomposeWhenChanged | bool | r/w | If true, recomposes all stories when the compose using settings are changed, or when words are added to or removed from the user dictionary. |
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 DictionaryPreference 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 DictionaryPreference.
Element of
Application.dictionaryPreferences
Document.dictionaryPreferences
Return
Array of DictionaryPreference DictionaryPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |