Check Method

Description

Checks text for spelling errors and fills the IncorrectWordCollection at TXSpell.IncorrectWords with all incorrect words. The first implementation uses selected dictionaries of the DictionaryCollection at TXSpell.Dictionaries. The second implementation uses selected dictionaries of the TXSpell.Dictionaries DictionaryCollection and the default dictionary folder where the dictionary's language equals to the defined language parameter. Only those dictionaries are used whose Dictionary.IsSpellCheckingEnabled properties are set to true.

Syntax

Check(string)

Checks text for spelling errors using selected dictionaries of the DictionaryCollection at TXSpell.Dictionaries.

public void Check(string text);

Public Sub Check(text As String)

Check(string, CultureInfo)

Checks text for spelling errors using selected dictionaries of the TXSpell.Dictionaries DictionaryCollection and the default dictionary folder where the dictionary's language equals to the defined language parameter.

public void Check(string text, CultureInfo language);

Public Sub Check(text As String, language As CultureInfo)

Examples

The following example uses Check in a focused TXSpell workflow. The created object is then available to the surrounding document workflow.

tXSpell.Check("Quarterly results", System.Globalization.CultureInfo.GetCultureInfo("en-US"));
Console.WriteLine("TXSpell is ready for use.");

tXSpell.Check("Quarterly results", System.Globalization.CultureInfo.GetCultureInfo("en-US"))
Console.WriteLine("TXSpell is ready for use.")

Remarks

This method throws an exception, if called while the SpellCheckDialog is open.

Further Reading

• Building a Spell Checking Web API in ASP.NET Core – May 15, 2020