HtmlInputText Class (System.Web.UI.HtmlControls)

Switch View

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

HtmlInputText Class

Allows programmatic access to the HTML <input type= text> and <input type= password> elements on the server.

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

Syntax

Visual Basic (Declaration)

<ValidationPropertyAttribute("Value")> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class HtmlInputText _
    Inherits HtmlInputControl _
    Implements IPostBackDataHandler

Visual Basic (Usage)

Dim instance As HtmlInputText

[ValidationPropertyAttribute("Value")]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class HtmlInputText : HtmlInputControl, 
    IPostBackDataHandler

Visual C++

[ValidationPropertyAttribute(L"Value")]
[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class HtmlInputText : public HtmlInputControl, 
    IPostBackDataHandler

JScript

public class HtmlInputText extends HtmlInputControl implements IPostBackDataHandler

ASP.NET

<asp:HtmlInputText />

Remarks

Use the HtmlInputText control to create a single-line text box that allows the user to enter text or a password. The MaxLength property specifies the maximum number of characters that can be entered in the text box. The Size property allows you to specify the width of the text box. To determine the value entered by the user into text box, use the Value property. The HtmlInputText control provides a ServerChange event that is raised when the Value property changes values between posts to the server. This allows you to create an event handler that performs a custom set of instructions each time the event is raised.

Note:
The HtmlInputText control does not provide a built-in way to post back to the server. You must provide another control on the Web page that supports posting to the server, such as an HtmlButton control, to send the value of the control back to the server.

To create a multi-line text box, use the HtmlTextArea control.

For a list of initial property values for an instance of HtmlInputText, see the HtmlInputText constructor.

Topic	Location
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications in Visual Studio
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications in Visual Studio
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications in Visual Studio
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications in Visual Studio

Examples

The following code example demonstrates how to use the HtmlInputText control to get user input.

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">

<script runat="server">

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

        Dim Answer As Integer

        Answer = Convert.ToInt32(Value1.Value) + Convert.ToInt32(Value2.Value)
        AnswerMessage.InnerHtml = Answer.ToString()

    End Sub

</script>

<html  > 
<head>
    <title> HtmlInputText Example </title>
</head>
<body>
<form id="form1" runat="server">
    <div>

    <h3> HtmlInputText Example </h3>

    <table>
        <tr>
            <td colspan="5">

               Enter integer values into the text boxes. <br />
               Click the Add button to add the two values. <br />
               Click the Reset button to reset the text boxes.

            </td>
       </tr>
       <tr>
            <td colspan="5">
                &nbsp;

            </td>
       </tr>
       <tr align="center">
            <td>

               <input id="Value1"
                      type="Text"
                      size="2"
                      maxlength="3"
                      value="1"
                      runat="server"/>

            </td>
            <td>
                + 
            </td>
            <td>

               <input id="Value2"
                      type="Text"
                      size="2"
                      maxlength="3"
                      value="1"
                      runat="server"/>

            </td>
            <td>
                =
            </td>
            <td>

               <span id="AnswerMessage"
                     runat="server"/>

            </td>
        </tr>
        <tr>
            <td colspan="2">

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

               <asp:CompareValidator
                    ID="Value1MinCompareValidator"
                    ControlToValidate="Value1"
                    Operator="LessThan"
                    Type="Integer"
                    ValueToCompare="100"
                    ErrorMessage="Please enter an integer less than 100.<br />"
                    Display="Dynamic"
                    runat="server"/>

               <asp:CompareValidator
                    ID="Value1MaxCompareValidator"
                    ControlToValidate="Value1"
                    Operator="GreaterThan"
                    Type="Integer"
                    ValueToCompare="0"
                    ErrorMessage="Please enter an integer greater than 0.<br />"
                    Display="Dynamic"
                    runat="server"/>

            </td>
            <td colspan="2">

               <asp:RequiredFieldValidator
                    ID="Value2RequiredValidator"
                    ControlToValidate="Value2"
                    ErrorMessage="Please enter a value.<br />"
                    Display="Dynamic"
                    runat="server"/>

               <asp:CompareValidator
                    ID="Value2MinCompareValidator"
                    ControlToValidate="Value2"
                    Operator="LessThan"
                    Type="Integer"
                    ValueToCompare="100"
                    ErrorMessage="Please enter an integer less than 100.<br />"
                    Display="Dynamic"
                    runat="server"/>

               <asp:CompareValidator
                    ID="Value2MaxCompareValidator"
                    ControlToValidate="Value2"
                    Operator="GreaterThan"
                    Type="Integer"
                    ValueToCompare="0"
                    ErrorMessage="Please enter an integer greater than 0.<br />"
                    Display="Dynamic"
                    runat="server"/>

            </td>
            <td>
                &nbsp;
            </td>
        </tr>
        <tr align="center">
            <td colspan="4">

                <input type="Submit"
                      name="AddButton"
                      value="Add"
                      onserverclick="AddButton_Click"
                      runat="server"/>

                &nbsp;&nbsp;&nbsp;

                <input type="Reset"
                      name="AddButton"
                      value="Reset"
                      runat="server"/>

            </td>
            <td>
                &nbsp;
            </td>
        </tr>
    </table>

    </div>
</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">

<script runat="server">

    protected void AddButton_Click(Object sender, EventArgs e)
    {
        int Answer;

        Answer = Convert.ToInt32(Value1.Value) + 
            Convert.ToInt32(Value2.Value);
        AnswerMessage.InnerHtml = Answer.ToString();

    }

</script>

<html  > 
<head>
    <title> HtmlInputText Example </title>
</head>
<body>
<form id="form1" runat="server">
    <div>

    <h3> HtmlInputText Example </h3>

    <table>
        <tr>
            <td colspan="5">

               Enter integer values into the text boxes. <br />
               Click the Add button to add the two values. <br />
               Click the Reset button to reset the text boxes.

            </td>
       </tr>
       <tr>
            <td colspan="5">
                &nbsp;

            </td>
       </tr>
       <tr align="center">
            <td>

               <input id="Value1"
                      type="Text"
                      size="2"
                      maxlength="3"
                      value="1"
                      runat="server"/>

            </td>
            <td>
                + 
            </td>
            <td>

               <input id="Value2"
                      type="Text"
                      size="2"
                      maxlength="3"
                      value="1"
                      runat="server"/>

            </td>
            <td>
                =
            </td>
            <td>

               <span id="AnswerMessage"
                     runat="server"/>

            </td>
        </tr>
        <tr>
            <td colspan="2">

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

               <asp:CompareValidator
                    ID="Value1MinCompareValidator"
                    ControlToValidate="Value1"
                    Operator="LessThan"
                    Type="Integer"
                    ValueToCompare="100"
                    ErrorMessage="Please enter an integer less than 100.<br />"
                    Display="Dynamic"
                    runat="server"/>

               <asp:CompareValidator
                    ID="Value1MaxCompareValidator"
                    ControlToValidate="Value1"
                    Operator="GreaterThan"
                    Type="Integer"
                    ValueToCompare="0"
                    ErrorMessage="Please enter an integer greater than 0.<br />"
                    Display="Dynamic"
                    runat="server"/>

            </td>
            <td colspan="2">

               <asp:RequiredFieldValidator
                    ID="Value2RequiredValidator"
                    ControlToValidate="Value2"
                    ErrorMessage="Please enter a value.<br />"
                    Display="Dynamic"
                    runat="server"/>

               <asp:CompareValidator
                    ID="Value2MinCompareValidator"
                    ControlToValidate="Value2"
                    Operator="LessThan"
                    Type="Integer"
                    ValueToCompare="100"
                    ErrorMessage="Please enter an integer less than 100.<br />"
                    Display="Dynamic"
                    runat="server"/>

               <asp:CompareValidator
                    ID="Value2MaxCompareValidator"
                    ControlToValidate="Value2"
                    Operator="GreaterThan"
                    Type="Integer"
                    ValueToCompare="0"
                    ErrorMessage="Please enter an integer greater than 0.<br />"
                    Display="Dynamic"
                    runat="server"/>

            </td>
            <td>
                &nbsp;
            </td>
        </tr>
        <tr align="center">
            <td colspan="4">

                <input type="Submit"
                      name="AddButton"
                      value="Add"
                      onserverclick="AddButton_Click"
                      runat="server"/>

                &nbsp;&nbsp;&nbsp;

                <input type="Reset"
                      name="AddButton"
                      value="Reset"
                      runat="server"/>

            </td>
            <td>
                &nbsp;
            </td>
        </tr>
    </table>

    </div>
</form>
</body>
</html>

.NET Framework Security

AspNetHostingPermission
for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
AspNetHostingPermission
for operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.

Inheritance Hierarchy

System..::.Object
  System.Web.UI..::.Control
    System.Web.UI.HtmlControls..::.HtmlControl
      System.Web.UI.HtmlControls..::.HtmlInputControl
        System.Web.UI.HtmlControls..::.HtmlInputText
          System.Web.UI.HtmlControls..::.HtmlInputPassword

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

HtmlInputText Members

System.Web.UI.HtmlControls Namespace

HtmlTextArea

HtmlInputPassword

Other Resources

HTML Server Controls