UserDictionary
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| addedWords | Array of string | r/w | A list of words added to the user dictionary. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the UserDictionary within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| name | string | readonly | The name of the UserDictionary. |
| parent | Application | readonly | The parent of the UserDictionary (a Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| removedWords | Array of string | r/w | A list of words 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) |
void addWord (addedWords:
Array
of string[, removedList:
bool=false])
Adds the specified words to the specified list in the dictionary.
| Parameter | Type | Description |
|---|---|---|
| addedWords | Array of string | The words to add. |
| removedList | bool | If true, adds the words to the removed words list. If false or unspecified, adds the words to the added words list. (Optional) (default: false) |
Array
of UserDictionary 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) |
void removeWord (removedWords:
Array
of string[, removedList:
bool=false])
Removes the specified words from the specified list in the dictionary.
| Parameter | Type | Description |
|---|---|---|
| removedWords | Array of string | The words to remove. |
| removedList | bool | If true, removes the words from the removed words list. If false or unspecified, removes the words from the added words list. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the UserDictionary.
Used in:
UserDictionary UserDictionaries.nextItem (obj: UserDictionary)
UserDictionary UserDictionaries.previousItem (obj: UserDictionary)
Return
UserDictionary UserDictionaries.[] (index: number)
UserDictionary UserDictionaries.anyItem ()
Array of UserDictionary UserDictionaries.everyItem ()
UserDictionary UserDictionaries.firstItem ()
UserDictionary UserDictionaries.item (index: varies)
UserDictionary UserDictionaries.itemByName (name: string)
Array of UserDictionary UserDictionaries.itemByRange (from: varies, to: varies)
UserDictionary UserDictionaries.lastItem ()
UserDictionary UserDictionaries.middleItem ()
UserDictionary UserDictionaries.nextItem (obj: UserDictionary)
UserDictionary UserDictionaries.previousItem (obj: UserDictionary)
Array of UserDictionary UserDictionary.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |