TXSpellChecker.OptionsDialog Method — TX Spell .NET for WPF

Description

Invokes the built-in dialog box to define spell check, create suggestions and hyphenation and create synonyms settings..

Invokes the built-in dialog box that shows all tabs.

public void OptionsDialog();

Public Sub OptionsDialog()

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.

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 `ShowDialogSettings` class to determine the dialog's start position and owner.

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 `ShowDialogSettings` class to determine the dialog's start position and owner.
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.

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.WPF.Proofing.ShowDialogSettings());
Console.WriteLine("TXSpell Checker is ready for use.");

tXSpellChecker.OptionsDialog(New TXTextControl.WPF.Proofing.ShowDialogSettings())
Console.WriteLine("TXSpell Checker is ready for use.")

The number of active tabs for the options dialog must be at least one. Otherwise, an ArgumentException is thrown.