Microsoft KB Archive/306459

= ASP.NET server controls overview =

Article ID: 306459

Article Last Modified on 5/17/2007

-

APPLIES TO


 * Microsoft ASP.NET 1.1
 * Microsoft ASP.NET 1.0

-



This article was previously published under Q306459



This article refers to the following Microsoft .NET Framework Class Library namespaces:
 * System.Web.UI.HtmlControls.HtmlControl
 * System.Web.UI.WebControls.WebControl



SUMMARY
This article provides an introduction to the ASP.NET server controls.

For additional ASP.NET overviews, refer to the following Microsoft Knowledge Base article:

305140 INFO: ASP.NET Roadmap



MORE INFORMATION
The ASP.NET page framework includes a number of built-in server controls that are designed to provide a more structured programming model for the Web. These controls provide the following features:
 * Automatic state management.
 * Simple access to object values without having to use the Request object.
 * Ability to react to events in server-side code to create applications that are better structured.
 * Common approach to building user interfaces for Web pages.
 * Output is automatically customized based on the capabilities of the browser.

In addition to the built-in controls, the ASP.NET page framework also provides the ability to create user controls and custom controls. User controls and custom controls can enhance and extend existing controls to build a much richer user interface.

HTML Server Controls
The HTML server controls are Hypertext Markup Language (HTML) elements that include a runat=server attribute. The HTML server controls have the same HTML output and the same properties as their corresponding HTML tags. In addition, HTML server controls provide automatic state management and server-side events. HTML server controls offer the following advantages:
 * The HTML server controls map one to one with their corresponding HTML tags.
 * When the ASP.NET application is compiled, the HTML server controls with the runat=server attribute are compiled into the assembly.
 * Most controls include an OnServerEvent for the most commonly used event for the control. For example, the control has an OnServerClick event.
 * The HTML tags that are not implemented as specific HTML server controls can still be used on the server side; however, they are added to the assembly as HtmlGenericControl.
 * When the ASP.NET page is reposted, the HTML server controls keep their values.

The System.Web.UI.HtmlControls.HtmlControl base class contains all of the common properties. HTML server controls derive from this class.

To use an HTML server control, use the following syntax (which uses the HtmlInputText control as an example):  For more information about individual HTML server controls that are available in ASP.NET, refer to the following Microsoft Web sites:

HtmlAnchor Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlanchorcontrol.asp

HtmlButton Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlbuttoncontrol.asp

HtmlForm Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlformcontrol.asp

HtmlImage Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlimagecontrol.asp

HtmlInputButton Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlinputbuttoncontrol.asp

HtmlInputCheckBox Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlinputcheckboxcontrol.asp

HtmlInputFile Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlinputfilecontrol.asp

HtmlInputHidden Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlinputhiddencontrol.asp

HtmlInputImage Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlinputimagecontrol.asp

HtmlInputRadioButton Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlinputradiobuttoncontrol.asp

HtmlInputText Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlinputtextcontrol.asp

HtmlSelect Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmlselectcontrol.asp

HtmlTable Control

http://msdn2.microsoft.com/en-us/library/2962t2k8(vs.71).aspx

HtmlTableCell Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmltablecellcontrol.asp

HtmlTableRow Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmltablerowcontrol.asp

HtmlTextArea Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhtmltextareacontrol.asp

back to the top

Web Server Controls
Web controls are very similar to the HTML server controls such as Button, TextBox, and Hyperlink, except that Web controls have a standardized set of property names. Web server controls offer the following advantages:
 * Make it easier for manufacturers and developers to build tools or applications that automatically generate the user interface.
 * Simplify the process of creating interactive Web forms, which requires less knowledge of how HTML controls work and make the task of using them less prone to errors.

The System.Web.UI.WebControls.WebControl base class contains all of the common properties. Most of the Web server controls derive from this class.

To use a Web server control, use the following syntax (which uses the TextBox control as an example):  Web server controls can be divided into four categories:
 * Basic Web Controls
 * Validation Controls
 * List Controls
 * Rich Controls

Basic Web Controls
Basic Web controls provide the same functionality as their HTML server control counterparts. However, basic Web control include additional methods, events, and properties against which you can program.

For more information about individual Web controls that are available in ASP.NET, refer to the following Microsoft Web sites:

Button Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconbuttonwebcontrol.asp

CheckBox Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconcheckboxwebservercontrol.asp

HyperLink Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconhyperlinkwebservercontrol.asp

Image Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconimagewebservercontrol.asp

ImageButton Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconimagebuttonwebcontrol.asp

Label Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconlabelwebservercontrol.asp

LinkButton Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconlinkbuttonwebcontrol.asp

Literal Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/gnconliteralwebservercontrol.asp

Panel Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconpanelwebservercontrol.asp

PlaceHolder Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/gnconplaceholderwebservercontrol.asp

RadioButton Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconradiobuttonwebservercontrol.asp

Table Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcontablewebcontrol.asp

TableCell Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcontablecellwebcontrol.asp

TableRow Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcontablerowwebcontrol.asp

TextBox Web Server Control

http://msdn2.microsoft.com/en-us/library/fhc2c904(vs.71).aspx

Validation Controls
Validation controls are used to validate the values that are entered into other controls of the page. Validation controls perform client-side validation, server-side validation, or both, depending on the capabilities of the browser in which the page is displayed. Validation controls offer the following advantages:
 * You can associate one or more validation controls with each control that you want to validate.
 * The validation is performed when the page form is submitted.
 * You can specify programmatically whether validation should occur, which is useful if you want to provide a cancel button so that the user can exit without having to fill valid data in all of the fields.
 * The validation controls automatically detect whether validation should be performed on the client side or the server side.

Note A client-side validation catches errors before a postback operation is complete. Therefore, if you have combinations of client-side and server-side validation controls on a single page, the server-side validation will be preempted if a client-side validation fails.

For more information about individual validation controls that are available in ASP.NET, refer to the following Microsoft Web sites:

RequiredFieldValidator Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconrequiredfieldvalidatorcontrol.asp

RangeValidator Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconrangevalidatorcontrol.asp

CompareValidator Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconcomparevalidatorcontrol.asp

RegularExpressionValidator Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconregularexpressionvalidatorcontrol.asp

CustomValidator Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconcustomvalidatorcontrol.asp

ValidationSummary Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconvalidationsummarycontrol.asp

List Controls
List controls are special Web server controls that support binding to collections. You can use list controls to display rows of data in a customized, templated format. All list controls expose DataSource and DataMember properties, which are used to bind to collections.

List controls can bind only to collections that support the IEnumerable, ICollection, or IListSource interfaces. For example, a Microsoft Visual C# .NET sample page appears as follows: <%@ Page Language=&quot;C#&quot; %>  Public void Page_Load {   String[] myStringArray = new String[] {&quot;one&quot;,&quot;two&quot;,&quot;three&quot;}; rptr.DataSource = myStringArray; rptr.DataBind; }  <%# Container.DataItem %>  A Microsoft Visual Basic .NET sample page appears as follows: <%@ Page Language=&quot;vb&quot; %>  public sub Page_Load Dim myStringArray as String myStringArray = new String {&quot;one&quot;,&quot;two&quot;,&quot;three&quot;} rptr.DataSource = myStringArray rptr.DataBind end sub  <%# Container.DataItem %>  The output appears as follows:

one

two

three

For more information about individual list controls that are available in ASP.NET, refer to the following Microsoft Web sites:

ListBox Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconlistboxwebservercontrol.asp

CheckBoxList Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconcheckboxlistwebservercontrol.asp

RadioButtonList Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconradiobuttonlistwebservercontrol.asp

Repeater Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconrepeaterwebservercontrol.asp

DataList Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcondatalistwebservercontrol.asp

DataGrid Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vbcon/html/vbconDataGridWebControl.asp

DropDownList Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcondropdownlistwebservercontrol.asp

Rich Controls
In addition to the preceding controls, the ASP.NET page framework provides a few, task-specific controls called rich controls. Rich controls are built with multiple HTML elements and contain rich functionality. Examples of rich controls are the Calendar control and the AdRotator control.

For more information about individual rich controls that are available in ASP.NET, refer to the following Microsoft Web sites:

AdRotator Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconadrotatorwebservercontrol.asp

Calendar Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconcalendarwebcontrol.asp

Xml Web Server Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/gnconxmlwebservercontrol.asp

back to the top

User Controls
Often, you may want to reuse the user interface of your Web Form without having to write any extra code. ASP.NET enables you to do this by converting your Web Forms into user controls. User controls, which have the .ascx file extension, can be used multiple times within a single Web Form.

To convert a Web Form into a user control, follow these steps:
 * 1) Remove all, , and tags.
 * 2) If the @ Page directive appears in the page, change it to @ Control.
 * 3) Include a className attribute in the @ Control directive so that the user control is typed strongly when you instantiate it.
 * 4) Give the control a descriptive file name, and change the file extension from .aspx to .ascx.

For more information about user controls, refer to the following topic in the Microsoft .NET Framework Software Development Kit (SDK) documentation:

Web Forms User Controls

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpguide/html/cpconwebformsusercontrols.asp

back to the top

Custom Controls
In addition to the built-in Web controls, ASP.NET also allows you to create your own custom controls. It may be useful to develop custom controls if you are faced with one of these scenarios:
 * You need to combine the functionality of two or more built-in Web controls.
 * You need to extend the functionality of a built-in control.
 * You need a control that is completely different than any of the controls that currently exist.

For more information about developing custom controls, refer to the following topics in the .NET Framework SDK documentation:

Developing ASP.NET Server Controls

http://msdn2.microsoft.com/en-us/library/aa719973(vs.71).aspx

Developing Custom Controls: Key Concepts

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpguide/html/cpconkeyconceptsinwebformscontroldevelopment.asp

Developing a Composite Control

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpguide/html/cpcondevelopingcompositecontrols.asp

back to the top

Keywords: kbarttyperoadmap kbdatabinding kbinfo kbservercontrols kbvalidation kbwebforms KB306459

-

[mailto:TECHNET@MICROSOFT.COM Send feedback to Microsoft]

© Microsoft Corporation. All rights reserved.