TX Spell .NET for Windows Forms

SuggestionList Class

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

Description

The SuggestionList class describes and handles attributes of the SpellCheckDialog's suggestion list. An instance of this class is provided by the SpellCheckDialog.SuggestionList property in TX Spell .NET for Windows Forms.

Syntax

public sealed class SuggestionList

Examples

The following example includes the max suggestions value from a Suggestion List object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Max Suggestions: {suggestionList.MaxSuggestions}");
Console.WriteLine("Suggestion List is ready for use.");

Members

Properties

PropertyDescription
IsNoSuggestionsItemEnabledGets or sets whether a message is displayed inside the SpellCheckDialog's suggestion list that informs the user that no suggestions could be created for the current incorrect word. The default value is true.
MaxSuggestionsGets or sets the maximum number of suggestions that has to be determined. The default value is 10.