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

InDesign Server CS5

Class

DictionaryPreference

 User dictionary preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
DictionaryPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
compositionComposeUsing:
ComposeUsing.USE_USER_DICTIONARY
ComposeUsing.USE_DOCUMENT
ComposeUsing.BOTH
r/wThe hyphenation exception list to use when composing text.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
mergeUserDictionarybool r/wIf true, merges the spelling and hyphenation exceptions lists in the external user dictionary with the lists stored within the document.
parentApplication
Document
readonlyThe parent of the DictionaryPreference (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
recomposeWhenChangedbool r/wIf true, recomposes all stories when the compose using settings are changed, or when words are added to or 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)

Array of DictionaryPreference 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)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.dictionaryPreferences

Document.dictionaryPreferences

Return

Array of DictionaryPreference DictionaryPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index