TextBoxBase.BorderStyle Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets the border type of the text box control.

public:
 property System::Windows::Forms::BorderStyle BorderStyle { System::Windows::Forms::BorderStyle get(); void set(System::Windows::Forms::BorderStyle value); };

public System.Windows.Forms.BorderStyle BorderStyle { get; set; }

member this.BorderStyle : System.Windows.Forms.BorderStyle with get, set

Public Property BorderStyle As BorderStyle

Property Value

BorderStyle

A BorderStyle that represents the border type of the text box control. The default is Fixed3D.

Exceptions

InvalidEnumArgumentException

A value that is not within the range of valid values for the enumeration was assigned to the property.

Examples

The following code example uses TextBox, a derived class, to create a text box that can properly display text using 20-point Arial with a single border. This example uses the PreferredHeight property to determine the appropriate height of the control after the font and BorderStyle have been assigned to the control.

public:
   void CreateTextBox()
   {
      // Create an instance of the TextBox control.
      TextBox^ textBox1 = gcnew TextBox;
      
      // Set the TextBox Font property to Arial 20.
      textBox1->Font = gcnew System::Drawing::Font( "Arial", 20 );
      // Set the BorderStyle property to FixedSingle.
      textBox1->BorderStyle = System::Windows::Forms::BorderStyle::FixedSingle;
      // Make the height of the control equal to the preferred height.
      textBox1->Height = textBox1->PreferredHeight;
   }

public void CreateTextBox()
 {
    // Create an instance of the TextBox control.
    TextBox textBox1 = new TextBox();
 
    // Set the TextBox Font property to Arial 20.
    textBox1.Font = new Font ("Arial" , 20);
    // Set the BorderStyle property to FixedSingle.
    textBox1.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle;
    // Make the height of the control equal to the preferred height.
    textBox1.Height = textBox1.PreferredHeight;
 }

Public Sub CreateTextBox()
    ' Create an instance of the TextBox control.
    Dim textBox1 As New TextBox()
    
    ' Set the TextBox Font property to Arial 20.
    textBox1.Font = New Font("Arial", 20)
    ' Set the BorderStyle property to FixedSingle.
    textBox1.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle
    ' Make the height of the control equal to the preferred height.
    textBox1.Height = textBox1.PreferredHeight
End Sub

Remarks

You can use the BorderStyle property to create borderless and flat style controls, in addition to the default three-dimensional control.

Note

The derived class, RichTextBox, does not support the BorderStyle.FixedSingle style. This style will cause the BorderStyle to use the BorderStyle.Fixed3D style instead.