InDesign Server2025
API 20.5.0.49
Object

SpellPreference

Spell-check preferences.

Preference SpellPreference
Hierarchy

Application

SpellPreference

Properties

NameType AccessDescription
Boolean read/write If true, checks for uncapitalized first words in sentences.
Boolean read/write If true, checks for uncapitalized proper nouns.
Boolean read/write If true, checks for misspelled words.
Boolean read/write If true, checks for repeated words.
Boolean read/write If 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.
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.
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write The 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.
Application readonly The parent of the SpellPreference (a Application).
Object read/write A property that allows setting of several properties at the same time.
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write The 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.
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write The 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.
3 Reals (0 - 255)[] | UIColors[]
+25 more
read/write The 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

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

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a SpellPreference.

Return 1

Methods that return a SpellPreference.