InDesign2026
API 21.5.1.73
Object

DictionaryPreference

User dictionary preferences.

Preference ›DictionaryPreference
Hierarchy

Application | Document

DictionaryPreference

Properties

NameType AccessDescription
ComposeUsing
read/write The hyphenation exception list to use when composing text.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Boolean read/write If true, merges the spelling and hyphenation exceptions lists in the external user dictionary with the lists stored within the document.
Application | Document readonly The parent of the DictionaryPreference (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write If true, recomposes all stories when the compose using settings are changed, or when words are added to or 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.
→ DictionaryPreference[]

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

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

→ String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a DictionaryPreference.

Return 1

Methods that return a DictionaryPreference.