Export (0) Print
Expand All

DataBoundControlAdapter Class

Customizes the behavior of a DataBoundControl object with which the adapter is associated for specific browser requests.

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

public ref class DataBoundControlAdapter : public WebControlAdapter

The DataBoundControlAdapter type exposes the following members.

  NameDescription
Public methodDataBoundControlAdapterInfrastructure. Initializes a new instance of the DataBoundControlAdapter class.
Top

  NameDescription
Protected propertyBrowserGets a reference to the browser capabilities of the client making the current HTTP request. (Inherited from ControlAdapter.)
Protected propertyControlRetrieves a strongly-typed reference to the DataBoundControl object associated with this control adapter.
Protected propertyIsEnabledGets a value indicating whether the Web control and all its parent controls are enabled. (Inherited from WebControlAdapter.)
Protected propertyPageGets a reference to the page where the control associated with this adapter resides. (Inherited from ControlAdapter.)
Protected propertyPageAdapterGets a reference to the page adapter for the page where the associated control resides. (Inherited from ControlAdapter.)
Top

  NameDescription
Protected methodBeginRenderCalled prior to the rendering of a control. In a derived adapter class, generates opening tags that are required by a specific target but not needed by HTML browsers. (Inherited from ControlAdapter.)
Protected methodCreateChildControlsCreates the target-specific child controls for a composite control. (Inherited from ControlAdapter.)
Protected methodEndRenderCalled after the rendering of a control. In a derived adapter class, generates closing tags that are required by a specific target but not needed by HTML browsers. (Inherited from ControlAdapter.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodLoadAdapterControlStateLoads adapter control state information that was saved by SaveAdapterControlState during a previous request to the page where the control associated with this control adapter resides. (Inherited from ControlAdapter.)
Protected methodLoadAdapterViewStateLoads adapter view state information that was saved by SaveAdapterViewState during a previous request to the page where the control associated with this control adapter resides. (Inherited from ControlAdapter.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnInitOverrides the OnInit method for the associated control. (Inherited from ControlAdapter.)
Protected methodOnLoadOverrides the OnLoad method for the associated control. (Inherited from ControlAdapter.)
Protected methodOnPreRenderOverrides the OnPreRender method for the associated control. (Inherited from ControlAdapter.)
Protected methodOnUnloadOverrides the OnUnload method for the associated control. (Inherited from ControlAdapter.)
Protected methodPerformDataBindingBinds the data in the data source of the associated DataBoundControl object to the control adapter.
Protected methodRenderGenerates the target-specific markup for the control to which the control adapter is attached. (Inherited from WebControlAdapter.)
Protected methodRenderBeginTagCreates the beginning tag for the Web control in the markup that is transmitted to the target browser. (Inherited from WebControlAdapter.)
Protected methodRenderChildrenGenerates the target-specific markup for the child controls in a composite control to which the control adapter is attached. (Inherited from ControlAdapter.)
Protected methodRenderContentsGenerates the target-specific inner markup for the Web control to which the control adapter is attached. (Inherited from WebControlAdapter.)
Protected methodRenderEndTagCreates the ending tag for the Web control in the markup that is transmitted to the target browser. (Inherited from WebControlAdapter.)
Protected methodSaveAdapterControlStateSaves control state information for the control adapter. (Inherited from ControlAdapter.)
Protected methodSaveAdapterViewStateSaves view state information for the control adapter. (Inherited from ControlAdapter.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

A control derived from the DataBoundControl class is bound to a data source and generates its user interface or child control hierarchy by enumerating the items in the data source to which it is bound. DataBoundControl is an abstract base class that defines the common characteristics of all controls that can be bound to a data source, such as the DataGrid and ListBox controls. For more information, see DataBoundControl.

A DataBoundControlAdapter modifies the behavior of a DataBoundControl for a specific browser or class of browsers, or acts as a filter on some capability. Much of the adaptability in rendering behavior can be encapsulated in the specialized classes that derive from the HtmlTextWriter class. Therefore, it is likely that a single adapter can be used for a number of browser class behaviors or that inclusion of the adaptability in the HtmlTextWriter classes can make the use of a control adapter unnecessary.

Each control has explicit mappings to adapters through the .browser definition files, if there are <controlAdapter> entries in these files. Thus, any access to the Adapter property of the DataBoundControl uses the HttpBrowserCapabilities object extracted from the .browser definition files to perform the lookup for the mapping of the adapter to control.

During processing, the .NET Framework intercepts calls to the methods of a control that could be browser specific. If a control adapter is attached, the .NET Framework calls the associated adapter methods. For more information, see ControlAdapter.

The M:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter.PerformDataBinding(System.Collections.IEnumerable) method binds an enumerable collection to the associated DataBoundControl. The Control property returns a strongly typed reference to the DataBoundControl.

The following code examples create and use two derived controls:

  • The MyDataBound class, derived from DataBoundControl, is a simple read-only grid control.

  • The MyDataBoundAdapter class, derived from DataBoundControlAdapter, renders the grid data as a one-dimensional list with row separators, suitable for small screen browsers.

The first code example uses a Web page to declare a MyDataBound control and an instance of ObjectDataSource that provides data in the form of a DataView object.

The second code example contains the derived MyDataBound and MyDataBoundAdapter classes:

No code example is currently available or this language may not be supported.

The third code example uses a configuration file to specify that no control adapter is to be used with MyDataBound controls for Microsoft Internet Explorer browsers, and that a MyDataBoundAdapter is used with MyDataBound controls for Openwave UP browsers.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, 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.

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