Adobe InDesign CS5 Server (7.0) Object Model JS: UserDictionary

InDesign Server CS5

Class

UserDictionary

 A user dictionary.

QuickLinks

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

Hierarchy

Application
UserDictionary
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
addedWords Array of string r/wA list of words added to the user dictionary.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the UserDictionary within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring readonlyThe name of the UserDictionary.
parentApplication readonlyThe parent of the UserDictionary (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
removedWords Array of string r/wA list of words removed from the user dictionary.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
addedWords Array of stringThe words to add.
removedListboolIf 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
removedWords Array of stringThe words to remove.
removedListboolIf 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.

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.3dContents :: Index