Version

Customizing How WinSpellChecker Spell Checks Documents

WinSpellChecker™ is capable of customizing the end user’s spell checking experience through a unique SpellOptions object. This object carries several properties that tell the spell checking engine what to check, what not to check, and what kind of suggestions to give. Most of these properties are simple Booleans that are easy to understand, such as whether or not to allow capitalized words or even words with a few capital letters in them. Some of these properties go deep into the heart of the spell checking engine and determine whether or not the engine will use hashing or phonetics to suggest corrections for misspelled words. Each property is explained in detail below along with its default value and an example to help you understand exactly what happens when you change the default value.

Property Default Value Description Example

False

WinSpellChecker checks the spelling of words with all capital letters. For example, the words in the Example column would be spelling errors.

AJAX

ATLAS

XML

True

WinSpellChecker converts the entire word to lowercase before spell checking it. For example, the words "bmW" or bMw would have the same suggestions, as illustrated in the Example column.

BMW

bum

False

WinSpellChecker treats words with mixed upper and lowercase letters as misspellings if they are not in the dictionary exactly as is. For example, The words in the Example column will be spelling errors.

HoUsE

PeoPLe

DoG

False

WinSpellChecker treats words with numbers in them (see the Example column) as misspelled words.

ultraWinGrid1

e11even

Allevi8

True

WinSpellChecker does not attempt to check the spelling of XML and HTML tags. For example, the tags in the Example column would be ignored.

<html>

<tr>

<span>

False

WinSpellChecker ignores words that should be separated by a space. This property is handy in languages such as German where two words can be combined to form a compound word (e.g. liederhosen). For example, the words in the Example column would not be spelling errors if this property were set to True.

Note
Note

Setting this property to True will significantly decrease performance.

Helloworld

Twolips

Tooltips

CheckCompoundWords

True

WinSpellChecker looks at each part of the hyphenated word to determine if there is a spelling error. Setting this property to False will force WinSpellChecker to check for the entire hyphenated word in the dictionary, not the separate parts. For example, the words in the Example column will all be spelling errors if this property is set to False; even though the separate words are spelled correctly.

right-click

spell-checker

hair-gel

80

WinSpellChecker considers suggested words with up to 80 characters for misspelled words. Setting this property to a lower value will increase the speed with which WinSpellChecker retrieves suggestions. If this value is set to a negative number at run time, it will default to 80.

If the ConsiderationRange is 3 and the misspelled word is 'carr', WinSpellChecker will suggest 'car'. If the ConsiderationRange is then set to 4, WinSpellChecker would then suggest 'care' as well as 'car'.

True

WinSpellChecker uses the user dictionary along with the default dictionary when suggesting corrections for misspelled words.

0

WinSpellChecker can use nine different language parsers to give the spell checking engine hints about punctuation usage. This property should match the language of the dictionary file being used.

0 – English

1 – Dutch

2 – French

3 – German

4 – Italian

5 – Portuguese

6 – Spanish

False

WinSpellChecker treats words with hyphens as one word. If set to True, only the misspelled portion of the hyphenated word is treated as an error.

SeparateHyphenWords = False:

Right-clck (entire word is an error)

SeparateHyphenWords = True:

Right-clck (only 'clck' is an error)

2

WinSpellChecker will retrieve suggestions for words as small as two characters. SuggestSplitWords must be set to True in order to use this property.

SplitWordThreshold = 2

Asfault ('As fault' is considered)

SplitWordThreshold = 3

Asfault ('As fault' is not considered)

0

WinSpellChecker will find suggestions by hashing the misspelled word. If set to PhoneticSuggestions, WinSpellChecker will search for suggestions phonetically.

0 – HashingSuggestions

1 – PhoneticSuggestions

True

If WinSpellChecker can see that a combined word is two separate words, the split word will appear as a suggestion. CheckCompoundWords must be set to False in order for this property to be used.

'helloword' will have 'hello world' as a suggestion.