SpellingCorrectionMode Enumeration
- Namespace
TXTextControl.Proofing
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTXSpell. WPF. SDK
- Assembly
TXSpell.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTXSpell. WPF. SDK TXSpell.from the setup.dll
- Also in
TXTextControl.asTXSpell. Core. SDK TXSpell.dll
Description
The enumeration contains the following values:
Syntax
public enum TXSpell.SpellingCorrectionModePublic Enum TXSpell.SpellingCorrectionModeMembers
| Value | Value | Description |
|---|---|---|
| CorrectionCompleted | 7 | The spelling correction ist completed. All prior uncorrected words were handled by methods of the TXSpell.SpellingCorrectionUIProvider.CorrectionHandler with the result, that the source (CurrentTextControl or CurrentText) of these words does not have further words to correct. In this the CurrentWordToCorrect property is set to null. |
| InitialState | 6 | The SpellingCorrectionUIProvider is set to its initial state. This value only appears if no TXTextControl.TextControl and no text are conntected to the SpellingCorrectionUIProvider. It is the initial state before setting the first time a TXTextControl.TextControl or text and can be forced by calling the Cancel method or SetCurrent with a null parameter. Under this mode it is not possible to force any spelling correction by using the SpellingCorrectionUIProvider. |
| NoSuggestionsCreated | 3 | Based on the selected suggestions dictionaries no suggestions were created for the current word to correct. |
| NoWordToCorrectSelected | 1 | The SetCurrent(int textPosition, object iFormattedText) or SetCurrent(int textPosition) method was called with the result, that there was no uncorrected word found at the specified text position. In this the CurrentWordToCorrect property are set to null. |
| NoWordsToCorrectFound | 0 | No correct words were found on setting the current textcontrol or text. In this case whether the CurrentWordToCorrect, nor the CurrentIFormattedText property of the TXSpell.SpellingCorrectionUIProvider.StateManager is set. Therefore no spelling correction based on the SpellingCorrectionUIProvider can be forced. |
| OptionsSettings | 8 | The SpellingCorrectionUIProvider is set to the only a mode were it is possible to modify options settings such as TXSpell.IgnoreWord, TXSpell.IgnoreCase or TXSpell.Dictionaries which have an effect on theTXSpell spell checking behavior. |
| SuggestionsCreated | 4 | Based on the selected suggestions dictionaries an array of suggestions was created for the current word to correct. |
| WordToCorrectEditing | 2 | The SpellingCorrectionUIProvider is set to a mode that corresponds to the state of a spell check dialog where the current word to correct is edited by the preview. |
| WordToCorrectIsDuplicate | 5 | The current word to correct is kind of duplicated word. |
Examples
The following example selects the No Words To Correct Found value from the Spelling Correction Mode enumeration and uses it as a documented workflow choice.
TXTextControl.Proofing.TXSpell.SpellingCorrectionMode value = TXTextControl.Proofing.TXSpell.SpellingCorrectionMode.NoWordsToCorrectFound;
Console.WriteLine($"Using Spelling Correction Mode: {value}");Dim value As TXTextControl.Proofing.TXSpell.SpellingCorrectionMode = TXTextControl.Proofing.TXSpell.SpellingCorrectionMode.NoWordsToCorrectFound
Console.WriteLine($"Using Spelling Correction Mode: {value}")