TXSpellChecker
TXSpellChecker is the spell checker of TX Spell .NET for WPF that you declare in the XAML of a window. It checks the text of a TX Text Control editor as the user types, checks the text of other controls on request, and brings the spell check dialog, the options dialog and the items of the spell check context menu. What follows describes what it does, how it connects to your controls and which members you use most.
What TXSpellChecker Is
The class is TXTextControl.WPF.Proofing.TXSpellChecker. It has no user interface of its own and isn't placed in the layout of a window: you declare it as a resource, and its dialogs and menus open only when a user or your code asks for them.
It comes with the NuGet package TXTextControl.TXSpell.WPF.SDK, in the assembly TXSpell.WPF.dll. The package brings the US English dictionary, hyphenation list and thesaurus with it. Code that uses the spell checker needs two namespaces: TXTextControl.WPF.Proofing for the spell checker and its dialogs, and TXTextControl.Proofing for the classes and enumerations it shares with the other TX Spell .NET products.
What You Do With It
- Check TX Text Control as the user types. Connected to a
TextControl, it underlines misspelled words with a red zigzag line and offers corrections in the context menu. As-You-Type Checking - Check any other control. Check finds the misspelled words of a text, such as the text of a
RichTextBoxor aTextBox. Checking on Demand - Walk the user through the misspelled words. Its spell check dialog and options dialog are built in. Spell Check Dialog and Options Dialog
- Offer suggestions. For a context menu of your own, a list or a dialog. Context Menu and Suggestion Controls
- Hyphenate, look up synonyms and detect languages, with the same language data. Hyphenation, Language Detection
One TXSpellChecker serves every control of a window: the dictionaries are loaded once, and a word the user adds to a user dictionary counts in all editors. Checking Multiple Controls shows how.
How You Connect It
To connect it to TX Text Control, declare the spell checker as a resource of the window and set the SpellChecker property of the TextControl to its key. As-You-Type Checking shows the XAML, and Create Your First WPF Application builds such a window step by step.
A RichTextBox, a TextBox or any other control doesn't talk to the spell checker itself: your code passes its text to Check and applies the corrections. Product Architecture describes the steps, and Checking on Demand shows the code.
Key Members
| Group | Members | Purpose |
|---|---|---|
| Checking | Check, IncorrectWords, IgnoreWord, IgnoreCase | Find misspelled words, and choose which words are skipped |
| Suggestions | CreateSuggestions, Suggestions | Create the corrections for a word |
| Dictionaries | Dictionaries, Language, AvailableDictionaries | Load dictionaries and user dictionaries, and choose the default one |
| Hyphenation | GetHyphenationPoints, HyphenationLists, HyphenationLanguage | Hyphenate words |
| Synonyms | CreateSynonyms, SynonymLists | Look up synonyms |
| Language detection | DetectLanguageScopes, DetectableLanguageScopes | Find out in which language a text is written |
| User interface | SpellCheckDialog, OptionsDialog, GetMenuItems, SpellingCorrectionUIProvider | Open the dialogs, build menus and correction panels |
| Events | IncorrectWordChanging, MisspelledWordChanging, SpellCheckDialogClosing, UserDictionaryWordAdded | React to corrections, the dialog and the dictionaries |
| Language data folders | DictionariesDirectoryPath, HyphenationListsDirectoryPath, SynonymListsDirectoryPath, LanguageRecognitionDirectoryPath | Read the language data from other folders than the defaults |
Events lists all events, and the TXSpellChecker reference all members.
Next Steps
- Create Your First WPF Application: a word processor with spell checking.
- TXSpell: the same checks without a user interface.
- Spell Check Dialog and Options Dialog: the dialogs of the spell checker.
- Loading and Managing Dictionaries: other languages and user dictionaries.