API Reference
When you need the exact name, signature or default of a class or member of TX Spell .NET for WPF, look it up in the API Reference. It documents every class, property, method, event and enumeration of the .NET class library and, where it is recorded, the version that introduced it. The guide pages of this documentation explain how to use the API and link each member they name to its page here.
What the Reference Covers
| Part | What it documents |
|---|---|
| .NET API | The namespaces of the class library: TXTextControl.Proofing and TXTextControl.WPF.Proofing |
TX Spell .NET for WPF has no JavaScript or web API of its own. In a web application, the spell checking engine runs on the server, as TX Text Control .NET Server Document Editor describes.
How a Reference Page Is Organized
A namespace lists its types; the page of a class lists its members; the page of a member gives the details:
- Declaration. The syntax of the member, in C# and Visual Basic.
- Parameters and return value. Each parameter with its type and meaning, and what the member returns.
- Introduced. The version of TX Spell .NET that added the member, where the reference records it.
- Remarks and limits. Defaults, restrictions such as "Read only", and notes on how the member behaves.
The reference is the authority on names. A blog article or a sample written for an older version may call a member that has changed since; when in doubt, check the name here.
Find the Right Page
| If you want to | Read |
|---|---|
| Look up a member of the spell checker | TXSpellChecker |
| Check text in code without a user interface | TXSpell |
| Find out which namespace a class belongs to | .NET API |
| Learn how the API is used before looking up its members | Spell Checking, Dictionaries and Languages or User Interface |
Pages in This Section
- .NET API: the namespaces of the .NET class library and what each one contains.