.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 Windows Forms has a single namespace, TXTextControl.Proofing, in the assemblies TXSpell.dll and TXSpell.Windows.Forms.dll. A namespace's page in the reference lists its classes and enumerations, and a class's page lists its members.
Namespace
| Namespace | What it contains | Start with |
|---|---|---|
| TXTextControl.Proofing | Everything: the spell checker component and its dialogs, the dictionaries and lists, the results and the events | TXSpellChecker, TXSpell |
The Classes by Task
| Task | Classes |
|---|---|
| The spell checker | TXSpellChecker, the component on a form; 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 Windows Forms and is documented there; TX Text Control .NET for Windows Forms 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.