Description

Returns a value whether the specified word was found in one of the current selected suggestion dictionaries or not.

Syntax

public bool CheckCorrectedWord(string correctedWord, out string messageText);

Public Function CheckCorrectedWord(correctedWord As String, ByRef messageText As String) As Boolean

Parameters

Parameter	Description
correctedWord	The specified word to check.
messageText	If the specified word was not found in one of the current selected suggestion dictionaries, the parameter is set to a message which informs the user about the result of this request. Otherwise it is set to an empty string.

Return Value

True if the specified word was found in one of the current selected suggestion dictionaries. Otherwise false.

Examples

The following example uses Check Corrected Word in a focused Correction Handler workflow.

string messageText = "Quarterly results";
if (correctionHandler.CheckCorrectedWord("Quarterly report", out messageText))
{
    Console.WriteLine("Check Corrected Word completed successfully.");
}

Dim messageText As String = "Quarterly results"
If correctionHandler.CheckCorrectedWord("Quarterly report", messageText) Then
    Console.WriteLine("Check Corrected Word completed successfully.")
End If

Remarks

This method is only enabled if the SpellingCorrectionUIProvider's mode is set to SuggestionsCreated or WordToCorrectEditing.