MaskedTextBox.Text Property

  • Reference

Definition

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

Gets or sets the text as it is currently displayed to the user.

public:
 virtual property System::String ^ Text { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Bindable(true)]
public override string Text { get; set; }
[<System.ComponentModel.Bindable(true)>]
member this.Text : string with get, set
Public Overrides Property Text As String

Property Value

String

A String containing the text currently displayed by the control. The default is an empty string.

Attributes
BindableAttribute

Examples

The following code example demonstrates the use of the Text property.

Private Sub DisplayText()
    Me.MaskedTextBox1.PasswordChar = CChar("*")

    Me.MaskedTextBox1.Mask = "000-00-0000" ' United States Social Security Number
    Me.MaskedTextBox1.Text = "999999999"

    Debug.WriteLine("MaskedControl.Text: " & Me.MaskedTextBox1.Text) ' Displays: 999-99-9
    Me.MaskedTextBox1.Text = ""

    ' Assigning text.
    Me.MaskedTextBox1.AllowPromptAsInput = True
    Me.MaskedTextBox1.Text = "999-99-9999" ' Works
    Me.MaskedTextBox1.Text = "999999999" ' Works
    Me.MaskedTextBox1.AllowPromptAsInput = False
    'Me.MaskedTextBox1.Text = "999-99-9999" ' Does not work
End Sub

Remarks

Text is the default binding property for the MaskedTextBox class.

Strings retrieved using this property are formatted according to the control's formatting properties, such as Mask and TextMaskFormat.

You can assign a string with or without literal characters to Text depending on the values of ResetOnPrompt, ResetOnSpace, and SkipLiterals.

Text is the default binding property for MaskedTextBox.

MaskedTextBox will raise the TextChanged event whenever the formatted text value changes. Different properties may or may not cause this value to change. For example, changing the PasswordChar property will not raise the TextChanged event, but changing the Mask property will.

Applies to

See also