TX Spell .NET for Windows Forms

RemoveWord Method

Method
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

Removes a word the user dictionary. The method has no effect if the UserDictionary.IsEditable property is false or the user dictionary is not added to the TXSpell.Dictionaries or TXSpellChecker.Dictionaries DictionaryCollection.

Syntax

public bool RemoveWord(string word);

Parameters

ParameterDescription
word

Specifies the word to remove from the user dictionary.

Return Value

The return value is true, if the word could be removed. Otherwise, it is false.

Examples

The following example uses Remove Word in a focused User Dictionary workflow.

if (userDictionary.RemoveWord("Quarterly report"))
{
    Console.WriteLine("Remove Word completed successfully.");
}