Skip to main content
.NET Framework Class Library
DataBoundControl Class

Serves as the base class for all ASP.NET version 2.0 data-bound controls that display their data in list or tabular form.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
Syntax
Public MustInherit Class DataBoundControl _
	Inherits [%$TOPIC/b1w1ak5a_en-us_VS_110_2_0_0_0_0%]
public abstract class DataBoundControl : [%$TOPIC/b1w1ak5a_en-us_VS_110_2_0_1_0_0%]
public ref class DataBoundControl abstract : public [%$TOPIC/b1w1ak5a_en-us_VS_110_2_0_2_0_0%]
[<[%$TOPIC/b1w1ak5a_en-us_VS_110_2_0_3_0_0%]>]
type DataBoundControl =  
    class 
        inherit [%$TOPIC/b1w1ak5a_en-us_VS_110_2_0_3_0_1%] 
    end
<asp:DataBoundControl />

The DataBoundControl type exposes the following members.

Constructors
  NameDescription
Protected method DataBoundControlInitializes the DataBoundControl class for use by an inherited class instance. This constructor can only be called by an inherited class.
Top
Properties
  NameDescription
Public property AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected property AdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public property AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public property AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public property BackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
Public property BindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public property BorderColorGets or sets the border color of the Web control. (Inherited from WebControl.)
Public property BorderStyleGets or sets the border style of the Web server control. (Inherited from WebControl.)
Public property BorderWidthGets or sets the border width of the Web server control. (Inherited from WebControl.)
Protected property ChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public property ClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public property ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected property ClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Protected property ContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public property ControlsGets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
Public property ControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public property ControlStyleCreatedGets 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 CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public property DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public property DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public property DataMemberGets or sets the name of the list of data that the data-bound control binds to, in cases where the data source contains more than one distinct list of data items.
Public property DataSourceGets or sets the object from which the data-bound control retrieves its list of data items. (Inherited from BaseDataBoundControl.)
Public property DataSourceIDGets or sets the ID of the control from which the data-bound control retrieves its list of data items. (Overrides BaseDataBoundControlDataSourceID.)
Public property DataSourceObjectGets an object that implements the IDataSource interface, which provides access to the object's data content.
Protected property DesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public property EnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public property EnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public property EnableViewStateGets 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 EventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public property FontGets the font properties associated with the Web server control. (Inherited from WebControl.)
Public property ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public property HasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected property HasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public property HeightGets or sets the height of the Web server control. (Inherited from WebControl.)
Public property IDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected property IdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected property InitializedGets a value indicating whether the data-bound control has been initialized. (Inherited from BaseDataBoundControl.)
Protected property IsBoundUsingDataSourceIDGets a value indicating whether the DataSourceID property is set. (Inherited from BaseDataBoundControl.)
Protected property IsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected property IsDataBindingAutomaticGets a value that indicates whether data binding is automatic. (Inherited from BaseDataBoundControl.)
Protected property IsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected property IsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected property IsUsingModelBindersGets a value that indicates whether model binding is in use. (Overrides BaseDataBoundControlIsUsingModelBinders.)
Protected property IsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public property ItemTypeGets or sets the name of the data item type for strongly typed data binding.
Protected property LoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public property NamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ControlID property value. (Inherited from Control.)
Public property PageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public property ParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public property RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Protected property RequiresDataBindingGets or sets a value indicating whether the DataBind method should be called. (Inherited from BaseDataBoundControl.)
Protected property SelectArgumentsGets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control.
Public property SelectMethodThe name of the method to call in order to read data.
Public property SiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public property SkinIDGets or sets the skin to apply to the control. (Inherited from WebControl.)
Public property StyleGets 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 SupportsDisabledAttributeGets 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 BaseDataBoundControl.)
Public property TabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected property TagKeyGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Protected property TagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public property TemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public property TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public property ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public property UniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public property ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Protected property ViewStateGets 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 ViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public property ViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public property VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public property WidthGets or sets the width of the Web server control. (Inherited from WebControl.)
Top
Methods
  NameDescription
Protected method AddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method AddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected method AddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.)
Public method ApplyStyleCopies 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 ApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected method BeginRenderTracingBegins design-time tracing of rendering data. (Inherited from Control.)
Protected method BuildProfileTreeInfrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.)
Protected method ClearCachedClientIDInfrastructure. Sets the cached ClientID value to . (Inherited from Control.)
Protected method ClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected method ClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Protected method ConfirmInitStateSets the initialized state of the data-bound control. (Inherited from BaseDataBoundControl.)
Public method CopyBaseAttributesCopies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method CreateChildControlsCalled by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.)
Protected method CreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected method CreateControlStyleCreates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method CreateDataSourceSelectArgumentsCreates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified.
Public method DataBindBinds a data source to the invoked server control and all its child controls. (Inherited from BaseDataBoundControl.)
Protected method DataBind(Boolean)Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
Protected method DataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public method DisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected method EndRenderTracingEnds design-time tracing of rendering data. (Inherited from Control.)
Protected method EnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected method EnsureDataBoundCalls the DataBind method if the DataSourceID property is set and the data-bound control is marked to require binding. (Inherited from BaseDataBoundControl.)
Protected method EnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected method FindControl(String, Int32)Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.)
Public method FocusSets input focus to a control. (Inherited from Control.)
Protected method GetDataRetrieves a DataSourceView object that the data-bound control uses to perform data operations.
Protected method GetDataSourceRetrieves the IDataSource interface that the data-bound control is associated with, if any.
Protected method GetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public method GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public method GetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method GetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public method HasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected method HasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected method IsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected method LoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected method LoadViewStateRestores view-state information from a previous page request that was saved by the SaveViewState method. (Overrides WebControlLoadViewState(Object).)
Protected method MapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected method MarkAsDataBoundSets the state of the control in view state as successfully bound to data.
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method MergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method OnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected method OnCreatingModelDataSourceRaises the CreatingModelDataSource event.
Protected method OnDataBindingRaises the DataBinding event. (Inherited from Control.)
Protected method OnDataBoundRaises the DataBound event. (Inherited from BaseDataBoundControl.)
Protected method OnDataPropertyChangedRebinds the data-bound control to its data after one of the base data source identification properties changes. (Overrides BaseDataBoundControlOnDataPropertyChanged.)
Protected method OnDataSourceViewChangedRaises the DataSourceViewChanged event.
Protected method OnInitHandles the Init event. (Inherited from BaseDataBoundControl.)
Protected method OnLoadHandles the ControlLoad event. (Overrides ControlOnLoad(EventArgs).)
Protected method OnPagePreLoadSets the initialized state of the data-bound control before the control is loaded. (Overrides BaseDataBoundControlOnPagePreLoad(Object, EventArgs).)
Protected method OnPreRenderHandles the PreRender event. (Inherited from BaseDataBoundControl.)
Protected method OnUnloadRaises the Unload event. (Inherited from Control.)
Protected method OpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected method PerformDataBindingWhen overridden in a derived class, binds data from the data source to the control.
Protected method PerformSelectRetrieves data from the associated data source. (Overrides BaseDataBoundControlPerformSelect.)
Protected method RaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected method RemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected method RenderRenders the control to the specified HTML writer. (Inherited from WebControl.)
Public method RenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method RenderChildrenOutputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
Protected method RenderContentsRenders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Public method RenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method ResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public method ResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public method ResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected method SaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected method SaveViewStateSaves any view-state changes that have occurred since the time the page was posted back to the server. (Overrides WebControlSaveViewState.)
Protected method SetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Public method SetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public method SetTraceData(Object, Object)Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control.)
Public method SetTraceData(Object, Object, Object)Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewStateCauses view-state changes to the control to be tracked so they can be stored in the control's StateBag object. (Overrides WebControlTrackViewState.)
Protected method ValidateDataSourceVerifies that the object a data-bound control binds to is one it can work with. (Overrides BaseDataBoundControlValidateDataSource(Object).)
Top
Events
  NameDescription
Public event CallingDataMethodsOccurs when data methods are being called.
Public event CreatingModelDataSourceOccurs when the ModelDataSource object is being created.
Public event DataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public event DataBoundOccurs after the server control binds to a data source. (Inherited from BaseDataBoundControl.)
Public event DisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.)
Public event InitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public event LoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public event PreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public event UnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top
Extension Methods
  NameDescription
Public Extension Method EnablePersistedSelectionEnables selection to be persisted in data controls that support selection and paging. (Defined by DynamicDataExtensions.)
Public Extension Method FindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension Method FindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension Method FindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method IAttributeAccessorGetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetation Private method IAttributeAccessorSetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetation Private property IControlBuilderAccessorControlBuilderFor a description of this member, see IControlBuilderAccessorControlBuilder. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorGetDesignModeStateFor a description of this member, see IControlDesignerAccessorGetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorSetDesignModeStateFor a description of this member, see IControlDesignerAccessorSetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessorSetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessorSetOwnerControl. (Inherited from Control.)
Explicit interface implemetation Private property IControlDesignerAccessorUserDataFor a description of this member, see IControlDesignerAccessorUserData. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessorDataBindingsFor a description of this member, see IDataBindingsAccessorDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessorHasDataBindingsFor a description of this member, see IDataBindingsAccessorHasDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessorExpressionsFor a description of this member, see IExpressionsAccessorExpressions. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessorHasExpressionsFor a description of this member, see IExpressionsAccessorHasExpressions. (Inherited from Control.)
Explicit interface implemetation Private method IParserAccessorAddParsedSubObjectFor a description of this member, see IParserAccessorAddParsedSubObject. (Inherited from Control.)
Top
Remarks

The DataBoundControl class is the base class used for ASP.NET controls that retrieve tabular or list-style data from an ASP.NET data source control and bind user-interface (UI) elements of the control to that data for display. Composite data-bound controls such as GridView, DetailsView, and FormView; list-style data-bound controls such as BulletedList and CheckBoxList; and other controls such as AdRotator derive from DataBoundControl.

Page developers do not use the DataBoundControl class directly; instead, they use controls that derive from this class.

Control developers extend this class to create data-bound controls that work with classes that implement the IDataSource interface and classes that derive from the DataSourceControl and DataSourceView classes. When deriving a class from the DataBoundControl class, override the PerformDataBinding method to bind the UI elements of your control to data retrieved by the GetData method. In most cases, the PerformDataBinding method is the only method you will override in your derived class.

For ASP.NET 2.0 data-bound controls, the PerformSelect method is the equivalent of the DataBind method, and is called to bind data at run time. The PerformSelect method calls the GetData and PerformDataBinding methods.

Examples

The following code example demonstrates how to derive a class from the DataBoundControl class to create a custom data-bound control. The TextBoxSet control creates a TextBox control for each data item retrieved from its associated data source control, and binds to the value of the data item at run time. The current implementation of the Render method renders the TextBox controls as an unordered list.

Imports System
Imports System.Collections
Imports System.ComponentModel
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls

Namespace Samples.AspNet.Controls.VB

<AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal), _
    AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class TextBoxSet
    Inherits DataBoundControl

    Private alBoxSet As IList

    Public ReadOnly Property BoxSet() As IList
        Get 
            If alBoxSet Is Nothing Then
                alBoxSet = New ArrayList()
            End If 
            Return alBoxSet
        End Get 
    End Property 

    Public Property DataTextField() As String 
        Get 
            Dim o As Object = ViewState("DataTextField")
            If o Is Nothing Then 
                Return String.Empty
            Else 
                Return CStr(o)
            End If 
        End Get 
        Set(ByVal value As String)
            ViewState("DataTextField") = value
            If (Initialized) Then
                OnDataPropertyChanged()
            End If 
        End Set 
    End Property 

    Protected Overrides Sub PerformSelect()

        ' Call OnDataBinding here if bound to a data source using the  
        ' DataSource property (instead of a DataSourceID) because the  
        ' data-binding statement is evaluated before the call to GetData. 
        If Not IsBoundUsingDataSourceID Then
            OnDataBinding(EventArgs.Empty)
        End If 

        ' The GetData method retrieves the DataSourceView object from the  
        ' IDataSource associated with the data-bound control.            
        GetData().Select(CreateDataSourceSelectArguments(), _
            AddressOf OnDataSourceViewSelectCallback)

        ' The PerformDataBinding method has completed.
        RequiresDataBinding = False
        MarkAsDataBound()

        ' Raise the DataBound event.
            OnDataBound(EventArgs.Empty)

    End Sub 'PerformSelect

    Private Sub OnDataSourceViewSelectCallback(ByVal retrievedData As IEnumerable)

        ' Call OnDataBinding only if it has not already 
        ' been called in the PerformSelect method. 
        If IsBoundUsingDataSourceID Then
            OnDataBinding(EventArgs.Empty)
        End If 
        ' The PerformDataBinding method binds the data in the retrievedData  
        ' collection to elements of the data-bound control.
        PerformDataBinding(retrievedData)

    End Sub 'OnDataSourceViewSelectCallback

    Protected Overrides Sub PerformDataBinding(ByVal retrievedData As IEnumerable)
        MyBase.PerformDataBinding(retrievedData)

        ' If the data is retrieved from an IDataSource as an IEnumerable  
        ' collection, attempt to bind its values to a set of TextBox controls. 
        If Not (retrievedData Is Nothing) Then 

            Dim dataItem As Object 
            For Each dataItem In retrievedData

                Dim box As New TextBox()

                ' The dataItem is not just a string, but potentially 
                ' a System.Data.DataRowView or some other container.  
                ' If DataTextField is set, use it to determine which  
                ' field to render. Otherwise, use the first field.                     
                If DataTextField.Length > 0 Then
                    box.Text = DataBinder.GetPropertyValue( _
                    dataItem, DataTextField, Nothing)
                Else 
                    Dim props As PropertyDescriptorCollection = _
                        TypeDescriptor.GetProperties(dataItem)

                    ' Set the "default" value of the TextBox.
                    box.Text = String.Empty

                    ' Set the true data-bound value of the TextBox, 
                    ' if possible. 
                    If props.Count >= 1 Then 
                        If props(0).GetValue(dataItem) IsNot Nothing Then
                            box.Text = props(0).GetValue(dataItem).ToString()
                        End If 
                    End If 
                End If

                BoxSet.Add(box)
            Next dataItem
        End If 

    End Sub 'PerformDataBinding

    Protected Overrides Sub Render(ByVal writer As HtmlTextWriter)

        ' Render nothing if the control is empty.             
        If BoxSet.Count <= 0 Then 
            Return 
        End If 

        ' Make sure the control is declared in a form tag with runat=server. 
        If Not (Page Is Nothing) Then
            Page.VerifyRenderingInServerForm(Me)
        End If 

        ' For this example, render the BoxSet as  
        ' an unordered list of TextBox controls.            
        writer.RenderBeginTag(HtmlTextWriterTag.Ul)

        Dim item As Object 
        For Each item In BoxSet

            Dim box As TextBox = CType(item, TextBox)

            ' Write each element as  
            ' <li><input type="text" value="string"><input/></li>
            writer.WriteBeginTag("li")
            writer.Write(">")
            writer.WriteBeginTag("input")
            writer.WriteAttribute("type", "text")
            writer.WriteAttribute("value", box.Text)
            writer.Write(">")
            writer.WriteEndTag("input")
            writer.WriteEndTag("li")
        Next item

        writer.RenderEndTag()

    End Sub 'Render
    End Class 'TextBoxSet 
End Namespace
using System;
using System.Collections;
using System.ComponentModel;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace Samples.AspNet.Controls.CS {

    [AspNetHostingPermission(SecurityAction.Demand, 
        Level=AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
        Level=AspNetHostingPermissionLevel.Minimal)]
    public class TextBoxSet : DataBoundControl {

        private IList alBoxSet;
        public IList BoxSet {
            get {
                if (null == alBoxSet) {
                     alBoxSet = new ArrayList();
                }
                return alBoxSet;                
            }                    
        }
        public string DataTextField {
            get {
                object o = ViewState["DataTextField"];
                return((o == null) ? string.Empty : (string)o);
            }
            set {
                ViewState["DataTextField"] = value;
                if (Initialized) {
                    OnDataPropertyChanged();
                }
            }
        }
        protected override void PerformSelect() {            

           // Call OnDataBinding here if bound to a data source using the 
           // DataSource property (instead of a DataSourceID), because the 
           // databinding statement is evaluated before the call to GetData.        
            if (! IsBoundUsingDataSourceID) {
                OnDataBinding(EventArgs.Empty);
            }            

            // The GetData method retrieves the DataSourceView object from   
            // the IDataSource associated with the data-bound control.            
            GetData().Select(CreateDataSourceSelectArguments(), 
                OnDataSourceViewSelectCallback);

            // The PerformDataBinding method has completed.
            RequiresDataBinding = false;
            MarkAsDataBound();

            // Raise the DataBound event.
            OnDataBound(EventArgs.Empty);
        }
        private void OnDataSourceViewSelectCallback(IEnumerable retrievedData) {

           // Call OnDataBinding only if it has not already been  
           // called in the PerformSelect method. 
            if (IsBoundUsingDataSourceID) {
                OnDataBinding(EventArgs.Empty);
            }
            // The PerformDataBinding method binds the data in the   
            // retrievedData collection to elements of the data-bound control.
            PerformDataBinding(retrievedData);                                    
        }
        protected override void PerformDataBinding(IEnumerable retrievedData) {
            base.PerformDataBinding(retrievedData);

            // If the data is retrieved from an IDataSource as an  
            // IEnumerable collection, attempt to bind its values to a  
            // set of TextBox controls. 
            if (retrievedData != null) {

                foreach (object dataItem in retrievedData) {

                    TextBox box = new TextBox();

                    // The dataItem is not just a string, but potentially 
                    // a System.Data.DataRowView or some other container.  
                    // If DataTextField is set, use it to determine which  
                    // field to render. Otherwise, use the first field.                     
                    if (DataTextField.Length > 0) {
                        box.Text = DataBinder.GetPropertyValue(dataItem, 
                            DataTextField, null);
                    }
                    else {
                        PropertyDescriptorCollection props = 
                            TypeDescriptor.GetProperties(dataItem);

                        // Set the "default" value of the TextBox.
                        box.Text = String.Empty;

                        // Set the true data-bound value of the TextBox, 
                        // if possible. 
                        if (props.Count >= 1) {                        
                            if (null != props[0].GetValue(dataItem)) {
                                box.Text = props[0].GetValue(dataItem).ToString();
                            }
                        }
                    }                                        

                    BoxSet.Add(box);
                }
            }
        }
        protected override void Render(HtmlTextWriter writer) {

            // Render nothing if the control is empty.             
            if (BoxSet.Count <= 0) {
                return;
            }

            // Make sure the control is declared in a form tag  
            // with runat=server. 
            if (Page != null) {
                Page.VerifyRenderingInServerForm(this);
            }

            // For this example, render the BoxSet as  
            // an unordered list of TextBox controls.            
            writer.RenderBeginTag(HtmlTextWriterTag.Ul);

            foreach (object item in BoxSet) {

                TextBox box = (TextBox) item;

                // Write each element as  
                // <li><input type="text" value="string"><input/></li>

                writer.WriteBeginTag("li");
                writer.Write(">");
                writer.WriteBeginTag("input");
                writer.WriteAttribute("type", "text");
                writer.WriteAttribute("value", box.Text);
                writer.Write(">");
                writer.WriteEndTag("input");
                writer.WriteEndTag("li");
            }            

            writer.RenderEndTag();                       
        }
    }
}

The following code example demonstrates how to use the TextBoxSet control, defined in the previous example, and bind it to an AccessDataSource control.

<%@Page language="VB" %>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.Controls.VB" 
    Assembly="Samples.AspNet.Controls.VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>TextBoxSet Data-Bound Control - VB Example</title>
  </head>

  <body>
    <form id="Form1" method="post" runat="server">

        <aspSample:textboxset
          id="TextBoxSet1"
          runat="server"
          datasourceid="AccessDataSource1" />

        <asp:accessdatasource
          id="AccessDataSource1"
          runat="server"
          datafile="Northwind.mdb"
          selectcommand="SELECT lastname FROM Employees" />

    </form>
  </body>
</html>
<%@Page language="c#" %>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.Controls.CS" 
    Assembly="Samples.AspNet.Controls.CS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>TextBoxSet Data-Bound Control  - C# Example</title>
  </head>

  <body>
    <form id="Form1" method="post" runat="server">

        <aspSample:textboxset
          id="TextBoxSet1"
          runat="server"
          datasourceid="AccessDataSource1" />

        <asp:accessdatasource
          id="AccessDataSource1"
          runat="server"
          datafile="Northwind.mdb"
          selectcommand="SELECT lastname FROM Employees" />

    </form>
  </body>
</html>
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0
Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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.