TextBoxBase.Modified Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

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 or sets a value that indicates that the text box control has been modified by the user since the control was created or its contents were last set.

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

[System.ComponentModel.Browsable(false)]
public bool Modified { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.Modified : bool with get, set

Public Property Modified As Boolean

Property Value

Boolean

true if the control's contents have been modified; otherwise, false. The default is false.

Attributes: BrowsableAttribute

Examples

The following code example uses the TextChanged event for a TextBox, a derived class, to determine if the contents of the TextBox control have changed since the control was filled with data. The example uses a string to store the original contents of the control and compares it against the contents of the TextBox to determine if the contents have changed. If the contents have changed, the Modified property is set to true. Otherwise, it is reset to false. This example requires that a TextBox control named textBox1 has been created and that a String variable named originalText has been created to store the original text for the TextBox control.

private:
   void TextBox1_TextChanged( Object^ sender, EventArgs^ e )
   {
      /* Check to see if the change made does not return the
         control to its original state. */
      if ( originalText != textBox1->Text )
      {
         // Set the Modified property to true to reflect the change.
         textBox1->Modified = true;
      }
      else
      {
         // Contents of textBox1 have not changed, reset the Modified property.
         textBox1->Modified = false;
      }
   }

private void TextBox1_TextChanged(object sender, EventArgs e)
 {
    /* Check to see if the change made does not return the
       control to its original state. */
    if (originalText != textBox1.Text)
       // Set the Modified property to true to reflect the change.
       textBox1.Modified = true;
    else
       // Contents of textBox1 have not changed, reset the Modified property.
       textBox1.Modified = false;
 }

Private Sub TextBox1_TextChanged(sender As Object, e As EventArgs)
    ' Check to see if the change made does not return the
    ' control to its original state. 
    If originalText <> textBox1.Text Then
        ' Set the Modified property to true to reflect the change.
        textBox1.Modified = True
        ' Contents of textBox1 have not changed, reset the Modified property.
    Else
        textBox1.Modified = False
    End If
End Sub

Remarks

You can use this property to determine if the user has modified the contents of the text box control. You can also set this property in code to indicate that changes were made to the text box control by the application. This property can be used by validation and data-saving methods to determine if changes were made in a text box control so the changed contents can be validated or saved.

If you change the Text property programmatically, the Modified property reverts to false. This does not raise the ModifiedChanged event.

Applies to

Dela via