K4 InDesign Javascript API Documentation

PreferencesDictionaryPreference

User dictionary preferences.

Extends

Instance Properties

Name Description Access
composition ComposeUsing The hyphenation exception list to use when composing text. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
mergeUserDictionary bool If true, merges the spelling and hyphenation exceptions lists in the external user dictionary with the lists stored within the document. read-write
parent The parent of the DictionaryPreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
recomposeWhenChanged bool If true, recomposes all stories when the compose using settings are changed, or when words are added to or removed from the user dictionary. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → DictionaryPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
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)
getElements(
)
  → DictionaryPreference
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)
toSource(
)
  → string
Generates a string which, if executed, will return the DictionaryPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.