This topic has not yet been rated - Rate this topic

TypeValidationEventArgs Class

Provides data for the TypeValidationCompleted event.

System.Object
  System.EventArgs
    System.Windows.Forms.TypeValidationEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public class TypeValidationEventArgs : EventArgs

The TypeValidationEventArgs type exposes the following members.

  Name Description
Public method TypeValidationEventArgs Initializes a new instance of the TypeValidationEventArgs class.
Top
  Name Description
Public property Cancel Gets or sets a value indicating whether the event should be canceled.
Public property IsValidInput Gets a value indicating whether the formatted input string was successfully converted to the validating type.
Public property Message Gets a text message describing the conversion process.
Public property ReturnValue Gets the object that results from the conversion of the formatted input string.
Public property ValidatingType Gets the type that the formatted input string is being validated against.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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.

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" );
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ