InDesign2026
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 21.5.1.73
Object

UserDictionary

A user dictionary.

Hierarchy

Application

UserDictionary

Properties

NameType AccessDescription
String[] read/write A list of words added to the user dictionary.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The index of the UserDictionary within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String readonly The name of the UserDictionary.
Application readonly The parent of the UserDictionary (a Application).
Object read/write A property that allows setting of several properties at the same time.
String[] read/write A list of words removed from the user dictionary.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

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

addedWords 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.
→ UserDictionary[]

Resolves the object specifier, creating an array of object references.

→ Boolean

Removes the event listener.

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.
→ void

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

removedWords 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.
→ String

Generates a string which, if executed, will return the UserDictionary.

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a UserDictionary.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a UserDictionary.

UserDictionaries.itemByRange(from)UserDictionaries.nextItem(obj)UserDictionaries.previousItem(obj)

Return 12

Methods that return a UserDictionary.

UserDictionaries.[]()UserDictionaries.anyItem()UserDictionaries.everyItem()UserDictionaries.firstItem()UserDictionaries.item()UserDictionaries.itemByName()UserDictionaries.itemByRange()UserDictionaries.lastItem()UserDictionaries.middleItem()UserDictionaries.nextItem()UserDictionaries.previousItem()UserDictionary.getElements()