TX Spell .NET for Windows Forms

Show Method

Method|Introduced in 3.0
Namespace
TXTextControl.Proofing
Package
TXTextControl.TXSpell.WinForms.SDK as TXSpell.Windows.Forms.dll from the private NuGet feed or Text Control Offline Packages

Description

Invokes the built-in dialog box for checking incorrect or misspelled (TXTextControl.TextControl.MisspelledWords) words. The first implementation opens the spell check dialog for checking of the TXSpellChecker.IncorrectWords collection in TXSpell for Windows Forms. To connect the SpellCheckDialog with an object of type TXTextControl.TextControl, the Show method provides the third implementation. At both implementations, the dialog's selected suggestion dictionary is specified through the SuggestionDictionaryComboBox.SuggestionDictionary property. The second and the fourth implementation can be used to invoke the dialog with another suggestion dictionary.

Syntax

Show()

Invokes the built-in dialog box for correcting incorrect words of the TXSpellChecker.IncorrectWords collection in TXSpell for Windows Forms. The SuggestionDictionaryComboBox.SuggestionDictionary is selected to create suggestions.

public void Show();

Show(Dictionary)

Invokes the built-in dialog box for checking incorrect words of the TXSpellChecker.IncorrectWords collection in TXSpell for Windows.Forms. The specified suggestion dictionary is selected to create suggestions.

public void Show(Dictionary suggestionDictionary);
ParameterDescription
suggestionDictionary

Specifies the dictionary used for creating suggestions. This parameter is only useful, if more than one dictionary has been added to the spellchecker's dictionary collection.

Show(object)

Invokes the built-in dialog box for checking misspelled words (TXTextControl.TextControl.MisspelledWords) of a specific TextControl (TXTextControl.TextControl). The SuggestionDictionaryComboBox.SuggestionDictionary is selected to create suggestions.

public void Show(object textControl);
ParameterDescription
textControl

Specifies the object of type TXTextControl.TextControl that is connected to the dialog.

Show(object, Dictionary)

Invokes the built-in dialog box for checking misspelled words (TXTextControl.TextControl.MisspelledWords) of a specific TextControl (TXTextControl.TextControl). The specified suggestion dictionary is selected to create suggestions.

public void Show(object textControl, Dictionary suggestionDictionary);
ParameterDescription
textControl

Specifies the object of type TXTextControl.TextControl that is connected to the dialog.

suggestionDictionary

Specifies the dictionary used for creating suggestions. This parameter is only useful, if more than one dictionary has been added to the spellchecker's dictionary collection.

Examples

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

spellCheckDialog.Show("Approved", new TXTextControl.Proofing.UserDictionary());
Console.WriteLine("Spell Check Dialog is ready for use.");