.NET API
Every class, property, method and event that your code calls is documented in the .NET class library reference, sorted by namespace. TX Spell .NET for WPF has two namespaces, TXTextControl.Proofing and TXTextControl.WPF.Proofing. A namespace's page in the reference lists its classes and enumerations, and a class's page lists its members.
Namespaces
| Namespace | What it contains | Start with |
|---|---|---|
| TXTextControl.Proofing | The spell checking engine and what both editions share: TXSpell, dictionaries and lists, results, most event arguments and the enumerations | TXSpell, Dictionary |
| TXTextControl.WPF.Proofing | The WPF spell checker and its user interface: TXSpellChecker, the spell check dialog, its buttons and preview, the menu items and the event arguments of the dialogs | TXSpellChecker, SpellCheckDialog |
The WPF edition splits its classes: the user interface is in TXTextControl.WPF.Proofing, in the assembly TXSpell.WPF.dll, and everything else in TXTextControl.Proofing, in TXSpell.dll. A class of the dialog or the menus is therefore written TXTextControl.WPF.Proofing.SpellCheckDialog, and a dictionary TXTextControl.Proofing.UserDictionary. The event arguments of the dialog and the menus belong to TXTextControl.WPF.Proofing; those of changing words and dictionaries to TXTextControl.Proofing.
The Classes by Task
| Task | Classes |
|---|---|
| The spell checker | TXSpellChecker, the component declared in XAML; TXSpell, the engine for code without a user interface |
| Dictionaries | Dictionary, OpenOfficeDictionary, UserDictionary and DictionaryCollection |
| Hyphenation and synonyms | HyphenationList, SynonymList, SynonymGroup and Synonym, with their collections |
| Results | IncorrectWord, Suggestion and LanguageScope, with their collections |
| The spell check dialog | SpellCheckDialog, SpellCheckDialogStateManager, DialogButton, Preview and SuggestionList |
| Context menus | MenuItem, the items that GetMenuItems returns |
| A user interface of your own | SpellingCorrectionUIProvider and its handlers |
| Events | The event arguments, such as IncorrectWordChangingEventArgs and SpellCheckDialogClosingEventArgs |
| Settings | The enumerations of TXSpell, such as TXSpell.IgnoreWordSettings and TXSpell.ChangeType |
The class TextControl of TX Text Control, which uses the spell checker, belongs to TX Text Control .NET for WPF and is documented there; TX Text Control .NET for WPF lists the members that work with TX Spell .NET.
Find the Right Class
| If you want to | Start with |
|---|---|
| Check the spelling as the user types or on demand | TXSpellChecker |
| Check a string in code | TXSpell, or Check of the spell checker |
| Add a language or words of your own | OpenOfficeDictionary, UserDictionary |
| Change the spell check dialog | SpellCheckDialog |
| Build a correction form of your own | SpellingCorrectionUIProvider |
The pages of Spell Checking, Dictionaries and Languages and User Interface show these classes at work and link each member they use to its reference page.
Pages in This Section
- TXTextControl.Proofing: the spell checking classes both editions share.
- TXTextControl.WPF.Proofing: the WPF spell checker and its user interface.