TX Spell .NET for Windows Forms

SuggestionsHandler Class

Class|Introduced in 6.0
Namespace
TXTextControl.Proofing
Package
TXTextControl.TXSpell.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXSpell.dll
Install
dotnet add package TXTextControl.TXSpell.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXSpell.dll from the setup.
Also in
TXTextControl.TXSpell.Core.SDK as TXSpell.dll
Implements
INotifyPropertyChanged

Description

The SuggestionsHandler class provides properties which are necessary to modify and perceive a list of suggestions for correcting the current word to corrct in a spelling correction user interface.

Syntax

public sealed class SpellingCorrectionUIProvider.SuggestionsHandler : INotifyPropertyChanged

Examples

The following example includes the is no suggestions item enabled value from a Suggestions Handler object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Is No Suggestions Item Enabled: {suggestionsHandler.IsNoSuggestionsItemEnabled}");
Console.WriteLine("Suggestions Handler is ready for use.");

Members

Properties

PropertyDescription
IsNoSuggestionsItemEnabledGets or sets whether a message is inside the SpellingCorrectionUIProvider's suggestion list that informs the user that no suggestions could be created for the current word to correct. The default value is true.
IsSuggestionListEnabledGets a value whether the Suggestions property is enabled to create suggestions or not.
MaxSuggestionsGets or sets the maximum number of suggestions that has to be determined. The default value is 10.
SuggestionsGets an array of suggestions which are created based on the selected suggestions dictionaries. The maximum number of items depends on the MaxSuggestion property.

Events

EventDescription
PropertyChangedNot described in the reference. public event PropertyChangedEventHandler PropertyChanged;