TX Spell .NET for WPF

Upgrading From Previous Versions

Topic

The steps of an upgrade to TX Spell .NET for WPF 11.0 differ for .NET Framework projects, which reference the assemblies of the installation, and .NET projects, which use NuGet packages. In both, the code stays the same: the What's New notes of versions 7.0 to 11.0 list no member of TX Spell .NET that was changed or removed.

Before You Start

  1. Read Breaking Changes for every version between yours and 11.0. An upgrade from 9.0 to 11.0 includes the changes of 10.0.
  2. Install the setup of version 11.0, TX Spell .NET for WPF 11.0 with SP1.exe, on the development machine; see Installing the Product. It installs the assemblies of 11.0 and adds the packages to the package source Text Control Offline Packages.

Upgrade a .NET Framework Project

  1. Open the project in Visual Studio.

  2. Remove the references to TXSpell.dll and TXSpell.WPF.dll.

  3. Add them again from the Assembly folder of the 11.0 installation.

  4. Open licenses.licx in the Properties folder (C#) or the My Project folder (Visual Basic). Entries without a version need no change, such as:

    TXTextControl.WPF.Proofing.TXSpellChecker, TXSpell.WPF

    An entry that names a version, such as TXTextControl.Proofing.TXSpell, TXSpell, Version=..., gets the version of the new assemblies, 11.0.1000.500.

  5. Rebuild the application and test it.

During development, the spell checker finds its dictionaries and other language data below the Assembly folder of the new installation. For deployment, ship the language data folders of version 11.0 with the application.

Upgrade a .NET Project From Version 10.0

The package keeps its name from version 10.0 to 11.0: TXTextControl.TXSpell.WPF.SDK is still TXTextControl.TXSpell.WPF.SDK. The package of version 10.0 installed in projects for .NET 5 and later; the package of version 11.0 targets .NET 8:

  1. Change the target framework of the project to .NET 8 or higher.
  2. Update TXTextControl.TXSpell.WPF.SDK to version 11.0.1, as Installing and Updating Packages shows.
  3. Rebuild the application and test it.

The package brings its license file and the language data, so nothing else needs to change. The XAML stays as it is: the xmlns:spell mapping to TXTextControl.WPF.Proofing in the assembly TXSpell.WPF and the spell checker resource are the same in every version.

Upgrade From Version 9.0 or Earlier

The first NuGet packages of TX Spell .NET came with version 10.0. A project for version 9.0 or earlier references the assemblies of the installation:

  • A .NET Framework project follows the steps for .NET Framework projects above.
  • A project for .NET Core 3.1, .NET 5 or .NET 6, which version 9.0 supported, switches to the package: remove the references, change the target framework to .NET 8 or higher, and install TXTextControl.TXSpell.WPF.SDK.

Use the Package for Code Without a User Interface

Version 11.0 adds the package TXTextControl.TXSpell.Core.SDK, which contains only the spell checking engine, the TXSpell class. Services, web applications and console applications that check text without a user interface can use it instead of the package for WPF; see Checking Text in Code.

Update Samples and Older Projects

The samples on GitHub and projects of colleagues were often built with an earlier version. Update an Older Sample shows the changes for the samples, and A Sample or an Old Project Doesn't Build the errors you may meet.

Next Steps