TXTextControl.ThesaurusDialog Class

The ThesaurusDialog class implements a Windows Forms dialog box that shows synonyms for selected text or a word at the current input position which will be selected on opening the dialog. If no text is selected or no word is located at the current input position, the dialog is opened without any created synonyms. For all these cases the dialog provides a text box to enter and edit that text which is used to find synonyms. Furthermore a combo box to select a specific language (a language item represents all enabled thesaurus files with the same culture) or thesaurus file (no language was defined for this file) is placed to the right of the text box. Both typing text into the text box and changing the selected language leads to an update of the displayed synonyms. Additionally new synonyms are created for the current selected synonym when the space key is pressed or the item is double clicked. In this case the back button is enabled to step back to the last synonym search request. To insert a selected synonym into the TextControl or to replace selected text with it, the user can press the Replace button or the Enter key.

Each item of the dialog box has a name, available through its Name property, which corresponds with a member of the ThesaurusDialog.DialogItem enumeration. The ThesaurusDialog.FindItem method can be used to get a certain item and manipulate, move or delete it.

To use this dialog the TextControl must be connected with an object of type TXSpellChecker (version 7.0 or higher). Otherwise an exception is thrown.

Introduced: 25.0.

Syntax

[C#]
public class ThesaurusDialog : System.Windows.Forms.Form
[Visual Basic]
Public Class ThesaurusDialog
  Inherits System.Windows.Forms.Form

Constructors

Constructor Description
ThesaurusDialog Creates a ThesaurusDialog object for the specified Windows Forms TextControl.

Methods

Method Description
FindItem Finds a control that has the provided identifier name.

Enumerations

Enumeration Description
DialogItem Each DialogItem represents an item in a ThesaurusDialog dialog box.

Example

The following example creates a ThesaurusDialog object and shows the dialog box:

[C#]
ThesaurusDialog dlg = new ThesaurusDialog(textControl1);
dlg.ShowDialog();
[Visual Basic]
Dim dlg As New ThesaurusDialog(textControl1)
dlg.ShowDialog()

See Also