TX Spell .NET for Windows Forms

RemoveAllWords 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 all words from 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 RemoveAllWords();

Return Value

The return value is true, if all words could be removed. Otherwise, it is false.

Examples

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

if (userDictionary.RemoveAllWords())
{
    Console.WriteLine("Remove All Words completed successfully.");
}