Adobe InDesign CS2 (4.0) Object Model JS: UserDictionary

previous page next page

Class

UserDictionary

A user dictionary.

UserDictionary

Property	Type	Access	Description
addedWords	Array of string	r/w	A list of words added to the user dictionary.
index	number	readonly	The index of the UserDictionary within its containing object.
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.

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 Object getElements ()
Resolves the object specifier, creating an array of object references.

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.

string toSpecifier ()
Retrieves the object specifier.