Cancel Property

TypeValidationEventArgs.Cancel Property


Gets or sets a value indicating whether the event should be canceled.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

member Cancel : bool with get, set

Property Value

Type: System.Boolean

true if the event should be canceled and focus retained by the MaskedTextBox control; otherwise, false to continue validation processing.

The TypeValidationCompleted event occurs just before the Validating event.

Setting the Cancel property to true in the TypeValidationCompleted event handler will cancel the event, causing the MaskedTextBox control to retain focus, unless the subsequent Validating event sets its version of the CancelEventArgs.Cancel property to false.

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the MaskedTextBox.TypeValidationCompleted event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox.Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type MaskedTextBox named MaskedTextBox1. Then ensure that the event handler is associated with the MaskedTextBox.TypeValidationCompleted event.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft