GitHub Examples
Only a handful of repositories in the GitHub organization TextControl use TX Spell .NET, because most of its sample code comes with the setup. The repositories that do exist show techniques beyond the setup samples, such as AutoCorrect in TX Text Control or a spell checking Web API. The table names the version each was written for, and the sections below show how to bring a sample to the current version.
The Repositories
| Example | What it shows | Where |
|---|---|---|
| AutoCorrect of two initial capitals | A word that starts with two capital letters is corrected while the user types, when its lowercase form is correct, as described in AutoCorrect: TWo INitial CApitals. TX Spell .NET 11.0 with TX Text Control 34.0, .NET Framework 4.5, C# | TextControl.Spelling.AutoCorrect |
| Interactive suggestions | A panel with up to six suggestions appears below a misspelled word while the user types, and a click replaces the word, as described in Interactive Spelling Suggestions Using TX Spell .NET. TX Spell .NET 11.0 with TX Text Control 33.0, .NET Framework 4.5, C# | TextControl.Spelling.AutoText |
| Spell checking Web API | An ASP.NET Core Web API that checks text, creates suggestions and synonyms and detects languages with the TXSpell class, as described in Building a Spell Checking Web API in ASP.NET Core. TXTextControl.TXSpell.Core.SDK 11.0.0, .NET 8, C# | TXTextControl.Core.Spell.WebAPI |
| Validation in ASP.NET Web Forms | A validator that checks the text of a form field on the server with TXSpell and shows the first suggestion, as described in Using TX Spell .NET in ASP.NET. TX Spell .NET 10.0, .NET Framework 4.0, C# | TXSpell.Web |
| ActiveX package for Visual Basic 6 | A COM wrapper around TX Spell .NET for Windows Forms, with Visual Basic 6 samples of spell checking, the dialog and the context menu, as described in TX Spell .NET ActiveX Package Released - Spell Checking in VB6. TX Spell .NET 10.0, .NET Framework 4.0, Visual Basic | TXSpell.ActiveX-Package |
| User dictionaries in the Document Editor | An ASP.NET MVC application with the Document Editor of TX Text Control .NET Server that lists the user dictionaries (.txd) stored on the server, loads the chosen one into the editor with loadUserDictionary and saveUserDictionary of the JavaScript API, and saves the words users added back to the server through a Web API, as described in Loading and Saving User Dictionaries in TextControl.Web. TXTextControl.Web 33.0.0, .NET Framework 4.8, C# and JavaScript | TextControl.Web.MVC.UserDictionary |
The Web API and the Web Forms samples use only the TXSpell class, which checks text without a user interface, and the user dictionary sample runs in the browser with TX Text Control .NET Server, whose Document Editor gets its spell checker from TXTextControl.TXSpell.Core.SDK; the other samples are Windows Forms applications. Spell Checking Examples and Dictionary and Language Examples list them by topic, next to the samples of the setup.
Run a Sample
Clone the repository and open the solution or project file at its root in Visual Studio; in the ActiveX package, it is in the folder AxTXSpell. The Web API is a .NET 8 project in the folder txspellwebapi, which the .NET CLI builds and runs:
git clone https://github.com/TextControl/TXTextControl.Core.Spell.WebAPI.git
cd TXTextControl.Core.Spell.WebAPI/txspellwebapi
dotnet restore
dotnet run
None of the repositories contains a nuget.config file. The Web API gets TXTextControl.TXSpell.Core.SDK from the package source Text Control Offline Packages that the setup adds; see Configuring Package Sources. The other samples reference the assemblies of TX Spell .NET directly.
Update an Older Sample
- Assembly references. The .NET Framework samples reference TXSpell.dll and TXSpell.Windows.Forms.dll of version 10.0 or 11.0, some with a path to the installation directory of version 10.0. Remove the references and add them again from the Assembly folder of your installation.
- NuGet packages. A project on .NET uses
TXTextControl.TXSpell.WinForms.SDKorTXTextControl.TXSpell.Core.SDK, and the packages of version 11.0 require .NET 8 or higher. Update them to the current version, 11.0.1. See Package Overview. - Breaking changes. Breaking Changes lists what changed between the versions.
Upgrading from Previous Versions describes the move of a project to the current version.
Next Steps
- Spell Checking Examples: the samples of the setup and the repositories by topic.
- Dictionary and Language Examples: dictionaries, hyphenation, synonyms and language detection.
- Getting Started: build a first application with the spell checker.