UserDictionary

Methods:

addEventListener, addWord, getElements, removeEventListener, removeWord, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, String

Property Listing

Property	Type	Access	Description
addedWords	Array of String	read/write	A list of words added to the user dictionary.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
index	Number	readonly	The index of the UserDictionary within its containing object.
isValid	Boolean	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	read/write	A property that allows setting of several properties at the same time.
removedWords	Array of String	read/write	A list of words 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)

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)

undefined addWord (addedWords:Array of String, [removedList:Boolean=Boolean])

Adds the specified words to the specified list in the dictionary.

Parameter	Type	Description
addedWords	Array of String	The words to add.
removedList	Boolean	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)

Parameter

Type

Description

addedWords

Array of String

The words to add.

removedList

Boolean

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)

UserDictionary 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)

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)

undefined removeWord (removedWords:Array of String, [removedList:Boolean=Boolean])

Removes the specified words from the specified list in the dictionary.

Parameter	Type	Description
removedWords	Array of String	The words to remove.
removedList	Boolean	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)

Parameter

Type

Description

removedWords

Array of String

The words to remove.

removedList

Boolean

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.