Breaking Changes
Upgrading TX Spell .NET for WPF is mostly a matter of the target framework of your project and the packages you install. From version 7.0 to 11.0, the What's New notes list new classes and members only, and none that were changed or removed. A few changes alter what users see, and you test them before you release the upgraded application.
Changes That Require Work
| Version | Change | What you do |
|---|---|---|
| 11.0 | The NuGet packages TXTextControl.TXSpell.WPF.SDK and TXTextControl.TXSpell.Core.SDK target .NET 8. The package of version 10.0 supported .NET 5, .NET 6 and .NET 7. | Change the target framework of projects on .NET 5, .NET 6 or .NET 7 to .NET 8 or higher, then install the 11.0 packages. |
| 7.0 | WPF applications require the .NET Framework 4.5 or higher. | Change the target framework of projects on an older .NET Framework to version 4.5 or higher. |
Versions 8.0, 9.0 and 10.0 have no change that requires work. Version 9.0 added properties for the folders of the language data, and version 10.0 added a NuGet package, but existing code and deployments keep working without it: the folder properties default to "(Auto)", which finds the folders where earlier versions did.
Behavior Changes to Test
These changes don't break the build, but they can change what your users see:
- Suggestions (10.0). CreateSuggestions uses the Hunspell REP flag of a dictionary, so dictionaries that contain it produce different suggestions for words typed without their diacritical marks or spelled by sound. If your application or its tests depend on specific suggestions, check them. See Version 10.0.
- User dictionaries with flags (8.0). When a user dictionary file starts with the flags
WORDCHARS,BREAKorICONV, TX Spell .NET applies them when it checks text. User dictionaries that your users created with older versions can contain such lines. See Version 8.0.
Update Together With TX Text Control
Each major version of TX Spell .NET was released together with a major version of TX Text Control: 11.0 with 33.0, 10.0 with 31.0, 9.0 with 30.0, 8.0 with X19 and 7.0 with X15. When you use TX Spell .NET with TX Text Control, plan both upgrades together, and read the Breaking Changes of TX Text Control .NET for WPF as well. TX Text Control X19, for example, changed when a word is checked while the user types; Version 8.0 describes it.
Plan an Upgrade
Read the changes of every version between yours and the new one: an upgrade from 9.0 to 11.0 includes the changes of 10.0. Upgrading from Previous Versions walks through the upgrade of a project, and Service Packs lists the latest service pack of each version.
Deprecated APIs shows whether your code uses members that are marked for removal.