Upraviť

Zdieľať cez

TypeValidationEventArgs Class

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Provides data for the TypeValidationCompleted event.

public ref class TypeValidationEventArgs : EventArgs
public class TypeValidationEventArgs : EventArgs
type TypeValidationEventArgs = class
    inherit EventArgs
Public Class TypeValidationEventArgs
Inherits EventArgs
Inheritance
Object
EventArgs
TypeValidationEventArgs

Examples

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the 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 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 TypeValidationCompleted event.

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

Remarks

The TypeValidationCompleted event occurs when a MaskedTextBox control performs optional type validation. Type validation occurs only when the MaskedTextBox.ValidatingType property is not null and a causal action occurs, such as the MaskedTextBox control losing focus. Type validation is the ability to convert the formatted input string to the type represented by the ValidatingType property. For more information about the type validation process, see the TypeValidationCompleted event.

If an event handler is implemented for TypeValidationCompleted, the handler receives a parameter of type TypeValidationEventArgs. This parameter contains information about the event, such as whether the type conversion process succeeded, the validating type, and so on.

Constructors

TypeValidationEventArgs(Type, Boolean, Object, String)

Initializes a new instance of the TypeValidationEventArgs class.

Properties

Cancel

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

Gets a value indicating whether the formatted input string was successfully converted to the validating type.
Message

Gets a text message describing the conversion process.
ReturnValue

Gets the object that results from the conversion of the formatted input string.
ValidatingType

Gets the type that the formatted input string is being validated against.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also