TX Spell .NET for Windows Forms

Remove 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 objects of the type Dictionary from the collection and invalidate them for spell checking and suggestion operations.

Syntax

public void Remove(Dictionary dictionary);

Parameters

ParameterDescription
dictionary

Specifies the dictionary.

Examples

The following example removes the first dictionary when the collection is not empty.

if (dictionaryCollection.Count > 0)
{
    TXTextControl.Proofing.Dictionary dictionary = dictionaryCollection[1];
    dictionaryCollection.Remove(dictionary);
}

Remarks

This method throws an exception when called while the SpellCheckDialog is open (except for removing dictionaries of type UserDictionary when the built-in options dialog was invoked by a SpellCheckdialog's dialog button).