TX Spell .NET for Windows Forms

Cancel Property

Property|Introduced in 3.0
Namespace
TXTextControl.Proofing
Package
TXTextControl.TXSpell.WinForms.SDK as TXSpell.Windows.Forms.dll from the private NuGet feed or Text Control Offline Packages

Description

Gets or sets a value indicating whether the event is canceled or not.

Syntax

public bool Cancel { get; set; }

Examples

The following example uses OptionsDialogOpeningEventArgs.Cancel to configure cancel as part of the options dialog opening event args workflow. The configured value is checked before the workflow continues.

optionsDialogOpeningEventArgs.Cancel = true;
if (optionsDialogOpeningEventArgs.Cancel)
{
    Console.WriteLine("Options Dialog Opening Event Args: Cancel is enabled.");
}