Breaking Changes
Upgrading TX Spell .NET for Windows Forms 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.WinForms.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 | The assemblies are compiled with the .NET Framework 4.0. | Change the target framework of projects on an older .NET Framework to version 4.0 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. - Scaling of the dialog boxes (8.0). The spell check dialog and the options dialog adapt their scaling to the monitor they are shown on. In the .NET Framework 4.7 and later, this requires the high DPI support to be switched on in app.config. Check the dialog boxes on monitors with different scale factors. 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 Windows Forms 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
The steps of an upgrade, for .NET Framework and .NET projects, are on Upgrading from Previous Versions. What to change and what to test depends on the version you come from:
| You come from | Change in the project | Test |
|---|---|---|
| 10.0 | Target .NET 8 or higher, then update the package to 11.0.1 | Nothing new |
| 9.0 or 8.0 | Update the references, or switch to the package | The suggestions (10.0) |
| 7.0 | Update the references | The suggestions (10.0), user dictionaries with flags and the scaling of the dialog boxes (8.0) |
| Earlier than 7.0 | Target the .NET Framework 4.0 or higher, then update the references | Everything above |
Afterward, install the latest service pack; Service Packs lists them. Deprecated APIs shows whether your code uses members that are marked for removal.