# TXSpellChecker.OptionsDialog Method

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

- **Product:** TX Spell .NET for Windows Forms
- **Section:** Reference
- **Kind:** Method
- **Namespace:** `TXTextControl.Proofing`
- **Package:** `TXTextControl.TXSpell.WinForms.SDK` (assembly `TXSpell.Windows.Forms.dll`, from the private NuGet feed or Text Control Offline Packages)
- **.NET Framework:** reference `TXSpell.Windows.Forms.dll` from the setup
- **Path:** TX Spell .NET for Windows Forms > Reference > TXTextControl.Proofing > TXSpellChecker.OptionsDialog Method
- **1402 words**
- **Web URL:** https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/optionsdialog-method/
- **LLMs URL:** https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/optionsdialog-method/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/optionsdialog-method/llms-full.txt

---

### Description

Invokes the built-in dialog box to define [spell check](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/check-method/llms-full.txt), [create suggestions](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/createsuggestions-method/llms-full.txt), [hyphenation](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/gethyphenationpoints-method/llms-full.txt) and [create synonyms](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/createsynonyms-method/llms-full.txt) settings.

### Syntax

#### OptionsDialog()

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

```csharp
public void OptionsDialog();
```

```vbnet
Public Sub OptionsDialog()
```

#### OptionsDialog(int\[\])

Invokes the built-in dialog box that shows those tabs that are related to the specified indices.

```csharp
public void OptionsDialog(int[] activeTabs);
```

```vbnet
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](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/ignorecase-property/llms-full.txt) and [ignoring words](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/ignoreword-property/llms-full.txt). The tab represented by index 1 displays all [loaded dictionaries](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/dictionaries-property/llms-full.txt). Tab 2 provides [hyphenation](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/llms-full.txt) options. Tab 3 shows an overview of all loaded [Thesaurus](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/hyphenationlists-property/llms-full.txt) files. |

#### OptionsDialog(ShowDialogSettings)

Invokes the built-in dialog box with a [ShowDialogSettings](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/showdialogsettings/llms-full.txt) instance that shows all tabs.

```csharp
public void OptionsDialog(ShowDialogSettings showDialogSettings);
```

```vbnet
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. |

#### OptionsDialog(ShowDialogSettings, int\[\])

Invokes the built-in dialog box with a [ShowDialogSettings](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/showdialogsettings/llms-full.txt) instance that shows those tabs that are related to the specified indices.

```csharp
public void OptionsDialog(ShowDialogSettings showDialogSettings, int[] activeTabs);
```

```vbnet
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](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/ignorecase-property/llms-full.txt) and [ignoring words](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/ignoreword-property/llms-full.txt). The tab represented by index 1 displays all [loaded dictionaries](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/dictionaries-property/llms-full.txt). Tab 2 provides [hyphenation](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/llms-full.txt) options. Tab 3 shows an overview of all loaded [Thesaurus](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/hyphenationlists-property/llms-full.txt) files. |

### Examples

The following example opens the options dialog for the txspell checker. The created object is then available to the surrounding document workflow.

```csharp
tXSpellChecker.OptionsDialog(new TXTextControl.Proofing.ShowDialogSettings());
Console.WriteLine("TXSpell Checker is ready for use.");
```

```vbnet
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.

---

## Nearby

- **Previous:** [TXSpellChecker.MisspelledWordChanging Event](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/misspelledwordchanging-event/llms-full.txt)
- **Next:** [TXSpellChecker.OptionsDialogOpening Event](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspellchecker/optionsdialogopening-event/llms-full.txt)