TypeValidationEventArgs.Cancel 属性

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

获取或设置指示是否应取消事件的值。

public:
 property bool Cancel { bool get(); void set(bool value); };

public bool Cancel { get; set; }

member this.Cancel : bool with get, set

Public Property Cancel As Boolean

属性值

Boolean

如果事件应取消，并且 MaskedTextBox 控件应保留焦点，则为 true；否则为 false，以继续验证过程。

示例

下面的代码示例演示了此成员的用法。 在此示例中，事件处理程序报告事件的发生情况 MaskedTextBox.TypeValidationCompleted 。 此报表可帮助你了解事件发生的时间，并可以帮助你进行调试。 若要报告多个事件或频繁发生的事件，请考虑将 MessageBox.Show 替换为 Console.WriteLine 或将消息追加到多行 TextBox。

若要运行示例代码，请将其粘贴到包含名为 MaskedTextBox1的 类型的MaskedTextBox实例的项目中。 然后，确保事件处理程序与 MaskedTextBox.TypeValidationCompleted 事件相关联。

private void MaskedTextBox1_TypeValidationCompleted(Object sender, TypeValidationEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "IsValidInput", e.IsValidInput );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Message", e.Message );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ReturnValue", e.ReturnValue );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ValidatingType", e.ValidatingType );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "TypeValidationCompleted Event" );
}

Private Sub MaskedTextBox1_TypeValidationCompleted(sender as Object, e as TypeValidationEventArgs) _ 
     Handles MaskedTextBox1.TypeValidationCompleted

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "IsValidInput", e.IsValidInput)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Message", e.Message)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "ReturnValue", e.ReturnValue)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "ValidatingType", e.ValidatingType)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"TypeValidationCompleted Event")

End Sub

注解

事件发生 TypeValidationCompleted 在 Validating 事件之前。

在事件处理程序中将 Cancel 属性设置为 true 将取消事件，导致MaskedTextBox控件保留焦点，除非后续Validating事件将其属性版本CancelEventArgs.Cancel设置为 falseTypeValidationCompleted 。

另请参阅

• TypeValidationCompleted
• Validating