TX Spell .NET for Windows Forms

SuggestionDictionariesHandler 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 SuggestionDictionariesHandler class provides properties which are necessary to perceive and modify suggestion dictionaries in a spelling correction user interface. These dictionaries are used to create suggestions which are related to the CurrentWordToCorrect.

Syntax

public sealed class SpellingCorrectionUIProvider.SuggestionDictionariesHandler : INotifyPropertyChanged

Examples

The following example includes the is suggestion dictionaries enabled value from a Suggestion Dictionaries Handler object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Is Suggestion Dictionaries Enabled: {suggestionDictionariesHandler.IsSuggestionDictionariesEnabled}");
Console.WriteLine("Suggestion Dictionaries Handler is ready for use.");

Members

Properties

PropertyDescription
IsSuggestionDictionariesEnabledGets a value whether the SuggestionDictionaries property is enabled to provide suggestion dictionaries or not.
SelectedSuggestionDictionariesGets or sets an array of dictionaries which are used to create suggestions for the SuggestionsHandler.Suggestions property. Changes on this property lead to an update of the StateManager.Mode and SuggestionsHandler.Suggestions properties.
SuggestionDictionariesGets an array of suggestion dictionaries where the dictionary's language equals to the language of the current word to correct. This property is redetermined on every change of the CurrentWordToCorrect property and lead to an update of the SelectedSuggestionDictionaries property.

Events

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