TX Spell .NET for Windows Forms

Suggestions Property

Property|Introduced in 6.0
Namespace
TXTextControl.Proofing
Package
TXTextControl.TXSpell.WinForms.SDK as TXSpell.dll from the private NuGet feed or Text Control Offline Packages
Also in
TXTextControl.TXSpell.Core.SDK as TXSpell.dll

Description

Gets an array of suggestions which are created based on the selected suggestions dictionaries. The maximum number of items depends on the MaxSuggestion property.

Syntax

public object[] Suggestions { get; }

Examples

The following example iterates through the suggestions collection and processes each object.

foreach (object item in suggestionsHandler.Suggestions)
{
    Console.WriteLine(item);
}

Limitations

Read only.

Remarks

This property is only enabled to create suggestions if the SpellingCorrectionUIProvider's mode is set to SuggestionsCreated or WordToCorrectEditing. If is the IsNoSuggestionsItemEnabled property is true and the SpellingCorrectionUIProvider's mode is set to NoSuggestionsCreated, the property returns an array containing one item which informs the user that no suggestions could be created. In all other circumstances the method returns an empty array.