TextBox.TextMode Property (System.Web.UI.WebControls)

TextMode Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

TextBox..::.TextMode Property

Gets or sets the behavior mode (single-line, multiline, or password) of the TextBox control.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

<ThemeableAttribute(False)> _
Public Overridable Property TextMode As TextBoxMode

Visual Basic (Usage)

Dim instance As TextBox
Dim value As TextBoxMode

value = instance.TextMode

instance.TextMode = value

[ThemeableAttribute(false)]
public virtual TextBoxMode TextMode { get; set; }

Visual C++

[ThemeableAttribute(false)]
public:
virtual property TextBoxMode TextMode {
    TextBoxMode get ();
    void set (TextBoxMode value);
}

JScript

public function get TextMode () : TextBoxMode
public function set TextMode (value : TextBoxMode)

ASP.NET

<asp:TextBox TextMode="TextBoxMode" />

Property Value

Type: System.Web.UI.WebControls..::.TextBoxMode
One of the TextBoxMode enumeration values. The default value is SingleLine.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The specified mode is not one of the TextBoxMode enumeration values.

Remarks

Use the TextMode property to specify whether a TextBox control is displayed as a single-line, multiline, or password text box.

When the TextBox control is in multiline mode, you can control the number of rows displayed by setting the Rows property. You can also specify whether the text should wrap by setting the Wrap property.

If the TextBox control is in password mode, all characters entered in the control are masked.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins Overview.

Topic	Location
How to: Get and Set Values in TextBox Web Server Controls	Building ASP .NET Web Applications
How to: Get and Set Values in TextBox Web Server Controls	Building ASP .NET Web Applications
How to: Get and Set Values in TextBox Web Server Controls	Building ASP .NET Web Applications in Visual Studio
How to: Set a TextBox Web Server Control for Password Entry	Building ASP .NET Web Applications
How to: Set a TextBox Web Server Control for Password Entry	Building ASP .NET Web Applications
How to: Set a TextBox Web Server Control for Password Entry	Building ASP .NET Web Applications in Visual Studio

Examples

The following code example demonstrates how to use the TextMode property to specify a multiline text box.

Security Note:
This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

Visual Basic

<%@ Page Language="VB" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  > 

<head>
    <title> MultiLine TextBox Example </title>
<script runat="server">

      Protected Sub SubmitButton_Click(sender As Object, e As EventArgs )

         Message.Text = "Thank you for your comment: <br />" + Comment.Text

      End Sub

      Protected Sub Check_Change(sender As Object, e As EventArgs )

         Comment.Wrap = WrapCheckBox.Checked
         Comment.ReadOnly = ReadOnlyCheckBox.Checked

      End Sub

   </script>

</head>

<body>

   <form id="form1" runat="server">

      <h3> MultiLine TextBox Example </h3>


      Please enter a comment and click the submit button. 

      <br /><br /> 

      <asp:TextBox ID="Comment"
           TextMode="MultiLine"
           Columns="50"
           Rows="5"
           runat="server"/>

      <br />

      <asp:RequiredFieldValidator
           ID="Value1RequiredValidator"
           ControlToValidate="Comment"
           ErrorMessage="Please enter a comment.<br />"
           Display="Dynamic"
           runat="server"/>                         

      <asp:CheckBox ID="WrapCheckBox"
           Text="Wrap Text"
           Checked="True"
           AutoPostBack="True"
           OnCheckedChanged="Check_Change"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:CheckBox ID="ReadOnlyCheckBox"
           Text="ReadOnly"
           Checked="False"
           AutoPostBack="True"
           OnCheckedChanged="Check_Change"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:Button ID="SubmitButton"
           Text="Submit"
           OnClick="SubmitButton_Click"
           runat="server"/>

      <hr />

      <asp:Label ID="Message"
           runat="server"/>

   </form>

</body>
</html>

<%@ Page Language="C#" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  > 

<head>
    <title> MultiLine TextBox Example </title>
<script runat="server">

      protected void SubmitButton_Click(Object sender, EventArgs e)
      {

         Message.Text = "Thank you for your comment: <br />" + Comment.Text;

      }

      protected void Check_Change(Object sender, EventArgs e)
      {

         Comment.Wrap = WrapCheckBox.Checked;
         Comment.ReadOnly = ReadOnlyCheckBox.Checked;

      }

   </script>

</head>

<body>

   <form id="form1" runat="server">

      <h3> MultiLine TextBox Example </h3>


      Please enter a comment and click the submit button. 

      <br /><br /> 

      <asp:TextBox ID="Comment"
           TextMode="MultiLine"
           Columns="50"
           Rows="5"
           runat="server"/>

      <br />

      <asp:RequiredFieldValidator
           ID="Value1RequiredValidator"
           ControlToValidate="Comment"
           ErrorMessage="Please enter a comment.<br />"
           Display="Dynamic"
           runat="server"/>                         

      <asp:CheckBox ID="WrapCheckBox"
           Text="Wrap Text"
           Checked="True"
           AutoPostBack="True"
           OnCheckedChanged="Check_Change"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:CheckBox ID="ReadOnlyCheckBox"
           Text="ReadOnly"
           Checked="False"
           AutoPostBack="True"
           OnCheckedChanged="Check_Change"
           runat="server"/>

      &nbsp;&nbsp;

      <asp:Button ID="SubmitButton"
           Text="Submit"
           OnClick="SubmitButton_Click"
           runat="server"/>

      <hr />

      <asp:Label ID="Message"
           runat="server"/>

   </form>

</body>
</html>

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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