Adobe InCopy CS6 (8.0) Object Model JS: SpellPreference

InCopy CS6

Class

SpellPreference

 Spell-check preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
SpellPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
checkCapitalizedSentencesbool r/wIf true, checks for uncapitalized first words in sentences.
checkCapitalizedWordsbool r/wIf true, checks for uncapitalized proper nouns.
checkMisspelledWordsbool r/wIf true, checks for misspelled words.
checkRepeatedWordsbool r/wIf true, checks for repeated words.
dynamicSpellCheckbool r/wIf true, underlines misspelled and repeated words, uncapitalized proper nouns, and uncapitalized first words in sentences. Note: Valid only when the corresponding properties are true. For information, see check misspelled words, check repeated words, check capitalized words, and check capitalized sentences.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
misspelledWordColor3 Reals (0 - 255)
UIColors
r/wThe underline color for misspelled words, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Valid only when both dynamic spell check and check misspelled words are true. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
parentApplication readonlyThe parent of the SpellPreference (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
repeatedWordColor3 Reals (0 - 255)
UIColors
r/wThe underline color for repeated words, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Valid only when both dynamic spell check and check repeated words are true. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
uncapitalizedSentenceColor3 Reals (0 - 255)
UIColors
r/wThe underline color for the first word in sentences that do not begin with a capital letter, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Valid when both dynamic spell check and check capitalized sentences are true. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
uncapitalizedWordColor3 Reals (0 - 255)
UIColors
r/wThe underline color for uncapitalized proper nouns, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Note: Valid only when both dynamic spell check and check capitalized words are true. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

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 SpellPreference 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 SpellPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.spellPreferences

Return

Array of SpellPreference SpellPreference.getElements ()

Jongware, 29-Apr-2012 v3.0.3iContents :: Index