Certified ASP.NET Programmer Learning Resources Accepting Data in a TextBox Control

Learning Resources
 

Accepting Data in a TextBox Control


The TextBox control generates single-line text boxes. The text that a user enters in a text box is stored in the Text property, which is inherited from the TextControl base class.

Creates single-line and multiline text boxes.


Remarks

The TextBox server control is an input control that lets the user enter text. By default, the TextMode property is set to SingleLine, which creates a text box with only one line. You can also set the property to MultiLine or Password. MultiLine creates a text box with more than one line. Password creates a single-line text box that masks the value entered by the user.

The display width of the text box is determined by its Columns property. If the text box is a multiline text box, the display height is determined by the Rows property.

Use the Text property to determine the contents of the TextBox control. You can limit the number of characters that can be entered in the control by setting the MaxLength property. Set the Wrap property to true to specify that the contents of the cell should automatically continue on the next line when the end of the text box is reached.

Example

The following shows a sample declaration for a TextBox control in an .aspx file. The control is multiline text box that displays a maximum of ten lines. The text is formatted in Arial font if the browser supports fonts for controls. The method txtLogin_Changed is bound to the control's TextChanged method.



Introduction

The TextBox server control is an input control that lets the user enter text. By default, the TextMode property of the control is set to TextBoxMode.SingleLine, which displays a single-line text box. However, you can also use the TextBox control to display a multiline text box or a text box that masks user input by changing the value of the TextMode property to TextBoxMode.MultiLine or TextBoxMode.Password, respectively. The text displayed in the TextBox control is specified or determined by using the Text property.

The TextBox control contains several properties that allow you to control the appearance of the control. The display width of the text box, in characters, is determined by its Columns property. If the TextBox control is a multiline text box, the number of rows it displays is determined by the Rows property. To display text that wraps within the TextBox control, set the Wrap property to true.

You can also specify how data is entered in the TextBox control by setting a few properties. To prevent the text displayed in the control from being modified, set the ReadOnly property to true. If you want to limit the user input to a specified number of characters, set the MaxLength property.



[ControlValuePropertyAttribute("Text")]
[ValidationPropertyAttribute("Text")]
public class TextBox : WebControl, IPostBackDataHandler, 
	IEditableTextControl, ITextControl

The TextBox type exposes the following members.

`
  Name Description
Public method TextBox Initializes a new instance of the TextBox class.
`
  Name Description
Public property AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected property Adapter Gets the browser-specific adapter for the control. (Inherited from Control.)
Public property AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public property Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public property AutoCompleteType Gets or sets a value that indicates the AutoComplete behavior of the TextBox control
Public property AutoPostBack Gets or sets a value that indicates whether an automatic postback to the server occurs when the TextBox control loses focus.
Public property BackColor Gets or sets the background color of the Web server control. (Inherited from WebControl.)
Public property BindingContainer Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public property BorderColor Gets or sets the border color of the Web control. (Inherited from WebControl.)
Public property BorderStyle Gets or sets the border style of the Web server control. (Inherited from WebControl.)
Public property BorderWidth Gets or sets the border width of the Web server control. (Inherited from WebControl.)
Public property CausesValidation Gets or sets a value indicating whether validation is performed when the TextBox control is set to validate when a postback occurs.
Protected property ChildControlsCreated Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public property ClientID Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public property ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected property ClientIDSeparator Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Public property Columns Gets or sets the display width of the text box in characters.
Protected property Context Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public property Controls Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
Public property ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public property ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
Public property CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public property DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public property DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Protected property DesignMode Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public property Enabled Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public property EnableTheming Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public property EnableViewState Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.)
Protected property Events Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public property Font Gets the font properties associated with the Web server control. (Inherited from WebControl.)
Public property ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public property HasAttributes Gets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected property HasChildViewState Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public property Height Gets or sets the height of the Web server control. (Inherited from WebControl.)
Public property ID Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected property IdSeparator Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected property IsChildControlStateCleared Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected property IsEnabled Gets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected property IsTrackingViewState Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected property IsViewStateEnabled Gets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Protected property LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public property MaxLength Gets or sets the maximum number of characters allowed in the text box.
Public property NamingContainer Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value. (Inherited from Control.)
Public property Page Gets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public property Parent Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public property ReadOnly Gets or sets a value indicating whether the contents of the TextBox control can be changed.
Public property RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public property Rows Gets or sets the number of rows displayed in a multiline text box.
Public property Site Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public property SkinID Gets or sets the skin to apply to the control. (Inherited from WebControl.)
Public property Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
Public property SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from WebControl.)
Public property TabIndex Gets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected property TagKey Gets the HTML tag for the text box control. This property is protected. (Overrides WebControl.TagKey.)
Protected property TagName Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public property TemplateControl Gets or sets a reference to the template that contains this control. (Inherited from Control.)
Public property TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public property Text Gets or sets the text content of the TextBox control.
Public property TextMode Gets or sets the behavior mode (single-line, multiline, or password) of the TextBox control.
Public property ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public property UniqueID Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public property ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Public property ValidationGroup Gets or sets the group of controls for which the TextBox control causes validation when it posts back to the server.
Protected property ViewState Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.)
Protected property ViewStateIgnoresCase Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public property ViewStateMode Gets or sets the view-state mode of this control. (Inherited from Control.)
Public property Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public property Width Gets or sets the width of the Web server control. (Inherited from WebControl.)
Public property Wrap Gets or sets a value indicating whether the text content wraps within a multiline text box.
`
  Name Description
Protected method AddAttributesToRender Infrastructure. Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter instance. (Overrides WebControl.AddAttributesToRender(HtmlTextWriter).)
Protected method AddedControl Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected method AddParsedSubObject Infrastructure. Overridden to allow only literal controls to be added as the Text property. (Overrides Control.AddParsedSubObject(Object).)
Public method ApplyStyle Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.)
Public method  For Support