TX Spell .NET for Windows Forms

DialogButton Class

Class|Introduced in 3.0
Namespace
TXTextControl.Proofing
Package
TXTextControl.TXSpell.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXSpell.Windows.Forms.dll
Install
dotnet add package TXTextControl.TXSpell.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXSpell.Windows.Forms.dll from the setup.

Description

The DialogButton class represents a button of the built-in SpellCheckDialog. Objects of this class can be added or removed to the dialog by modifying the SpellCheckDialog.IgnoreButtons, SpellCheckDialog.ChangeButtons and SpellCheckDialog.OptionButtons dialog button collections.

Syntax

public sealed class DialogButton

Examples

The following example creates a Dialog Button instance and configures its enabled setting for a document workflow.

TXTextControl.Proofing.DialogButton dialogButton = new(TXTextControl.Proofing.TXSpell.ButtonType.AddToDictionary);
dialogButton.Enabled = true;

Members

Constructors

ConstructorDescription
DialogButtonInitializes a new instance of the DialogButton class.

Properties

PropertyDescription
EnabledGets or sets a value indicating whether the DialogButton can respond to user interaction.
FontGets or sets the font of the text displayed by the DialogButton.
IsDeleteButtonGets or sets a value specifying the DialogButton text. The behavior changes to a Delete button, if the incorrect word (TXTextControl.MisspelledWord) is a duplicated word (TXTextControl.MisspelledWord.IsDuplicate).
IsUndoEditButtonGets or sets a value specifying the DialogButton text. The behavior changes to an Undo Edit button, if the preview text of the SpellCheckDialog is manually modified. When no button in the dialog is set to true, the preview text is not editable.
TextGets or sets the text displayed by the DialogButton.
TypeGets a value of type ButtonType that is specified for the DialogButton.