K4 InDesign Javascript API Documentation

TextUserDictionary

A user dictionary.

Instance Properties

Name Description Access
addedWords string A list of words added to the user dictionary. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the UserDictionary within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the UserDictionary. read-only
parent Application The parent of the UserDictionary (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
removedWords string A list of words removed from the user dictionary. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
addWord(
addedWords ​[, removedList])
getElements(
)
  → UserDictionary
removeEventListener(
eventType, handler ​[, captures])
  → bool
removeWord(
removedWords ​[, removedList])
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
addWord(
addedWords ​[, removedList=false])
Adds the specified words to the specified list in the dictionary.
addedWords Array<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)
getElements(
)
  → UserDictionary
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
removeWord(
removedWords ​[, removedList=false])
Removes the specified words from the specified list in the dictionary.
removedWords Array<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)
toSource(
)
  → string
Generates a string which, if executed, will return the UserDictionary.
toSpecifier(
)
  → string
Retrieves the object specifier.