SpellCheckDialog Class
- Namespace
TXTextControl.WPF. Proofing
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTXSpell. WPF. SDK
- Assembly
TXSpell.WPF. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTXSpell. WPF. SDK TXSpell.from the setup.WPF. dll
Description
The SpellCheckDialog class provides a method to modify and show the built-in spell check dialog.
Syntax
public sealed class SpellCheckDialogPublic NotInheritable Class SpellCheckDialogExamples
The following example includes the accept button value from a Spell Check Dialog object in application diagnostics. The created object is then available to the surrounding document workflow.
Console.WriteLine($"Accept Button: {spellCheckDialog.AcceptButton}");
Console.WriteLine("Spell Check Dialog is ready for use.");Console.WriteLine($"Accept Button: {spellCheckDialog.AcceptButton}")
Console.WriteLine("Spell Check Dialog is ready for use.")Members
Properties
| Property | Description |
|---|---|
| AcceptButton | Gets or sets the dialog button that is used as the SpellCheckDialog's accept button. The default value is the Ignore Once button. |
| ChangeButtons | Gets a collection of all dialog buttons that are located to the right of the SpellCheckDialog's suggestion list. The property's value is an object of type DialogButtonCollection and can be modified by using its methods and properties. The default content of that collection are buttons of type Change and ChangeAll. |
| ChangeInAllTextParts | Gets or sets a value indicating whether the SpellCheckDialog change operation is applied in all text parts (TXTextControl.WPF.TextControl.TextParts). The default value is true. |
| CloseOnFinished | Gets or sets a value specifying whether the SpellCheckDialog is closed on completing the spell checking. The default value is true. |
| FontFamily | Gets or sets the font family for the text displayed by the SpellCheckDialog labels, the preview, suggestion list, suggestion dictionary combo box and the cancel button. |
| FontSize | Gets or sets the font size for the text displayed by the SpellCheckDialog labels, the preview, suggestion list, suggestion dictionary combo box and the cancel button. |
| FontStyle | Gets or sets the font style for the text displayed by the SpellCheckDialog labels, the preview, suggestion list, suggestion dictionary combo box and the cancel button. |
| FontWeight | Gets or sets the font weight for the text displayed by the SpellCheckDialog labels, the preview, suggestion list, suggestion dictionary combo box and the cancel button. |
| HideSelection | Gets or sets a value indicating whether the selected text in the TXTextControl.WPF.TextControl remains highlighted while the SpellCheckDialog is open. The default value is false. |
| IgnoreButtons | Gets a collection of all dialog buttons that are located to the right of the SpellCheckDialog's preview component. The property's value is an object of type DialogButtonCollection and can be modified by using its methods and properties. The default content of that collection are buttons of type 'Ignore', 'IgnoreAll' and 'AddToDictionary'. |
| IgnoreInAllTextParts | Gets or sets a value indicating whether the SpellCheckDialog ignore operation should be applied in all text parts (TXTextControl.WPF.TextControl.TextParts). The default value is true. |
| Location | Returns the point that represents the upper-left corner of the SpellCheckDialog window in screen coordinates. |
| OptionButtons | Gets a collection of all dialog buttons that are located below the SpellCheckDialog's suggestion dictionary combo box. The property's value is an object of type DialogButtonCollection and can be modified by using its methods and properties. The default content of that collection is a button of type Options. |
| Preview | Gets the SpellCheckDialog's Preview instance. This property describes and handles attributes of the spell check dialog's preview component. |
| ShowDialogSettings | Gets or sets an instance of the ShowDialogSettings class to determine the SpellCheckDialog window's start position and owner. |
| ShowMessageBoxes | Gets or sets a value indicating whether the dialog should invoke built-in message boxes that inform the user that the spell checking is completed or that a chosen word is not found in one of the suggestion dictionaries. The default value is true. |
| SuggestionDictionaryComboBox | Gets the SpellCheckDialog's SuggestionDictionaryComboBox instance. This property describes and handles attributes of the spell check dialog's suggestion dictionary combo box. |
| SuggestionList | Gets the SpellCheckDialog's SuggestionList instance. This property describes and handles attributes of the spell check dialog's suggestion list. |
Methods
| Method | Description |
|---|---|
| Show | Invokes the built-in dialog box for checking incorrect or misspelled (TXTextControl.WPF.TextControl.MisspelledWords) words. The first implementation opens the spell check dialog for checking of the TXSpellChecker.IncorrectWords collection in TX Spell for WPF. To connect the SpellCheckDialog with an object of type TXTextControl.WPF.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. |