TypeValidationEventArgs.ReturnValue Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the object that results from the conversion of the formatted input string.
public:
property System::Object ^ ReturnValue { System::Object ^ get(); };
public object ReturnValue { get; }
public object? ReturnValue { get; }
member this.ReturnValue : obj
Public ReadOnly Property ReturnValue As Object
Property Value
If the validation is successful, an Object that represents the converted type; otherwise, null
.
Examples
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.
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 type validation process attempts to convert the formatted input string, not including prompt characters, to the type specified by the ValidatingType property. The ReturnValue property represents the result of the conversion attempt, and is equivalent to the value returned by the ValidateText method of the MaskedTextBox class.