Export (0) Print
Expand All

TextBoxBase.Multiline Property

Gets or sets a value indicating whether this is a multiline text box control.

[Visual Basic]
Public Overridable Property Multiline As Boolean
[C#]
public virtual bool Multiline {get; set;}
[C++]
public: __property virtual bool get_Multiline();
public: __property virtual void set_Multiline(bool);
[JScript]
public function get Multiline() : Boolean;
public function set Multiline(Boolean);

Property Value

true if the control is a multiline text box control; otherwise, false.

Remarks

A multiline text box allows you to display more than one line of text in the control. If the WordWrap property is set to true, text entered into the multiline text box is wrapped to the next line in the control. If the WordWrap property is set to false, text entered into the multiline text box control will be displayed on the same line until a newline character is entered.

The following can be used as newline characters:

  • System.Environment.Newline.
  • ControlChars.CrLf.
  • vbCrLf (Visual Basic only).

You can add scroll bars to a text box using the ScrollBars property to display horizontal and/or vertical scroll bars. This allows the user to scroll through the text that extends beyond the dimensions of the control.

Note   This property is set to false by default for all derived classes, with the exception of the RichTextBox control.

Example

[Visual Basic, C#, C++] The following example uses TextBox, a derived class, to create a multiline TextBox control with vertical scroll bars. This example also uses the AcceptsTab, AcceptsReturn, and WordWrap properties to make the multiline text box control useful for creating text documents.

[Visual Basic] 
Public Sub CreateMyMultilineTextBox()
    ' Create an instance of a TextBox control.
    Dim textBox1 As New TextBox()
    
    ' Set the Multiline property to true.
    textBox1.Multiline = True
    ' Add vertical scroll bars to the TextBox control.
    textBox1.ScrollBars = ScrollBars.Vertical
    ' Allow the RETURN key in the TextBox control.
    textBox1.AcceptsReturn = True
    ' Allow the TAB key to be entered in the TextBox control.
    textBox1.AcceptsTab = True
    ' Set WordWrap to true to allow text to wrap to the next line.
    textBox1.WordWrap = True
    ' Set the default text of the control.
    textBox1.Text = "Welcome!"
End Sub


[C#] 
public void CreateMyMultilineTextBox()
 {
    // Create an instance of a TextBox control.
    TextBox textBox1 = new TextBox();
    
    // Set the Multiline property to true.
    textBox1.Multiline = true;
    // Add vertical scroll bars to the TextBox control.
    textBox1.ScrollBars = ScrollBars.Vertical;
    // Allow the RETURN key in the TextBox control.
    textBox1.AcceptsReturn = true;
    // Allow the TAB key to be entered in the TextBox control.
    textBox1.AcceptsTab = true;
    // Set WordWrap to true to allow text to wrap to the next line.
    textBox1.WordWrap = true;
    // Set the default text of the control.
    textBox1.Text = "Welcome!";
 }
 

[C++] 
public:
    void CreateMyMultilineTextBox() {
        // Create an instance of a TextBox control.
        TextBox __gc *textBox1 = new TextBox();

        // Set the Multiline property to true.
        textBox1->Multiline = true;
        // Add vertical scroll bars to the TextBox control.
        textBox1->ScrollBars = ScrollBars::Vertical;
        // Allow the RETURN key in the TextBox control.
        textBox1->AcceptsReturn = true;
        // Allow the TAB key to be entered in the TextBox control.
        textBox1->AcceptsTab = true;
        // Set WordWrap to true to allow text to wrap to the next line.
        textBox1->WordWrap = true;
        // Set the default text of the control.
        textBox1->Text = S"Welcome!";
    };

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

TextBoxBase Class | TextBoxBase Members | System.Windows.Forms Namespace | Lines | WordWrap | ScrollBars

Show:
© 2014 Microsoft