OptionsDialog Method
- Namespace
TXTextControl.Proofing
- Package
TXTextControl.asTXSpell. WinForms. SDK TXSpell.from the private NuGet feed or Text Control Offline PackagesWindows. Forms. dll
Description
Invokes the built-in dialog box to define spell check, create suggestions, hyphenation and create synonyms settings.
Syntax
OptionsDialog()
Invokes the built-in dialog box that shows all tabs.
public void OptionsDialog();Public Sub OptionsDialog()OptionsDialog(int[])
Invokes the built-in dialog box that shows those tabs that are related to the specified indices.
public void OptionsDialog(int[] activeTabs);Public Sub OptionsDialog(activeTabs As Integer())| Parameter | Description |
|---|---|
| activeTabs | Specifies the indices of the tabs, zero-based, which are displayed when the tabbed dialog box is opened. Index 0 stands for the spell checking options tab such as case sensitivity and ignoring words. The tab represented by index 1 displays all loaded dictionaries. Tab 2 provides hyphenation options. Tab 3 shows an overview of all loaded Thesaurus files. |
OptionsDialog(ShowDialogSettings)
Invokes the built-in dialog box with a ShowDialogSettings instance that shows all tabs.
public void OptionsDialog(ShowDialogSettings showDialogSettings);Public Sub OptionsDialog(showDialogSettings As ShowDialogSettings)| Parameter | Description |
|---|---|
| showDialogSettings | Sets an instance of the |
OptionsDialog(ShowDialogSettings, int[])
Invokes the built-in dialog box with a ShowDialogSettings instance that shows those tabs that are related to the specified indices.
public void OptionsDialog(ShowDialogSettings showDialogSettings, int[] activeTabs);Public Sub OptionsDialog(showDialogSettings As ShowDialogSettings, activeTabs As Integer())| Parameter | Description |
|---|---|
| showDialogSettings | Sets an instance of the |
| activeTabs | Specifies the indices of the tabs, zero-based, which are displayed when the tabbed dialog box is opened. Index 0 stands for the spell checking options tab such as case sensitivity and ignoring words. The tab represented by index 1 displays all loaded dictionaries. Tab 2 provides hyphenation options. Tab 3 shows an overview of all loaded Thesaurus files. |
Examples
The following example opens the options dialog for the txspell checker. The created object is then available to the surrounding document workflow.
tXSpellChecker.OptionsDialog(new TXTextControl.Proofing.ShowDialogSettings());
Console.WriteLine("TXSpell Checker is ready for use.");tXSpellChecker.OptionsDialog(New TXTextControl.Proofing.ShowDialogSettings())
Console.WriteLine("TXSpell Checker is ready for use.")Remarks
The number of active tabs for the options dialog must be at least one. Otherwise, an ArgumentException is thrown.