TextBoxBase::Lines Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the lines of text in a text box control.

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

public:
property array<String^>^ Lines {
	array<String^>^ get();
	void set(array<String^>^ value);
}

Property Value

Type: array<System::String^>^

An array of strings that contains the text in a text box control.

Each element in the array becomes a line of text in the text box control. If the Multiline property of the text box control is set to true and a newline character appears in the text, the text following the newline character is added to a new element in the array and displayed on a separate line.

System_CAPS_noteNote

By default, the collection of lines is a read-only copy of the lines in the TextBox. To get a writable collection of lines, use code similar to the following: textBox1.Lines = new string[] { "abcd" };

The following code example uses TextBox, a derived class, to extract all strings of text from a multiline text box control and displays them using the Debug::WriteLine method. This example requires that a TextBox control has been created, named textBox1, and that it has been filled with lines of text.

public:
   void ViewMyTextBoxContents()
   {
      #if defined(DEBUG)
      // Create a string array and store the contents of the Lines property.
      array<String^>^ tempArray = gcnew array<String^>( textBox1->Lines->Length );
      tempArray = textBox1->Lines;

      // Loop through the array and send the contents of the array to debug window.
      for ( int counter = 0; counter < tempArray->Length; counter++ )
      {
         System::Diagnostics::Debug::WriteLine( tempArray[ counter ] );
      }
      #endif
   }

.NET Framework
Available since 1.1
Return to top
Show: