TextBoxBase.AppendText Method (System.Windows.Forms)

.NET Framework Class Library

TextBoxBase..::.AppendText Method

Appends text to the current text of a text box.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic (Declaration)

Public Sub AppendText ( _
    text As String _
)

Visual Basic (Usage)

Dim instance As TextBoxBase
Dim text As String

instance.AppendText(text)

public void AppendText(
    string text
)

Visual C++

public:
void AppendText(
    String^ text
)

JScript

public function AppendText(
    text : String
)

Parameters

text: Type: System..::.String
The text to append to the current contents of the text box.

Remarks

You can use this method to add text to the existing text in the control instead of using the concatenation operator (+) to concatenate text to the Text property.

Examples

The following code example demonstrates how to use the AppendText method and the TextLength property to copy text from one TextBox to another. This example requires that two TextBox controls named, textBox1 and textBox2, have been added to a form and that textBox1 has text assigned to its Text property.

Visual Basic

Private Sub AppendTextBox1Text()
   ' Determine if text is selected in textBox1.
   If textBox1.SelectionLength = 0 Then
      ' No selection made, return.
      Return
   End If
   ' Determine if the text being appended to textBox2 exceeds the MaxLength property.
   If textBox1.SelectedText.Length + textBox2.TextLength > textBox2.MaxLength Then
      MessageBox.Show("The text to paste in is larger than the maximum number of characters allowed")
      ' Append the text from textBox1 into textBox2.
   Else
      textBox2.AppendText(textBox1.SelectedText)
   End If
End Sub

private void AppendTextBox1Text()
{
   // Determine if text is selected in textBox1.
   if(textBox1.SelectionLength == 0)
      // No selection made, return.
      return;

   // Determine if the text being appended to textBox2 exceeds the MaxLength property.
   if((textBox1.SelectedText.Length + textBox2.TextLength) > textBox2.MaxLength)
      MessageBox.Show("The text to paste in is larger than the maximum number of characters allowed");
   else
      // Append the text from textBox1 into textBox2.
      textBox2.AppendText(textBox1.SelectedText);
}

Visual C++

void AppendTextBox1Text()
{
   // Determine if text is selected in textBox1.
   if ( textBox1->SelectionLength == 0 )

   // No selection made, return.
   return;

   // Determine if the text being appended to textBox2 exceeds the MaxLength property.
   if ( (textBox1->SelectedText->Length + textBox2->TextLength) > textBox2->MaxLength )
         MessageBox::Show( "The text to paste in is larger than the maximum number of characters allowed" ); // Append the text from textBox1 into textBox2.
   else
         textBox2->AppendText( textBox1->SelectedText );
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

TextBoxBase Class

TextBoxBase Members

System.Windows.Forms Namespace

Copy

Paste