DataBoundControlAdapter Class

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)

System.Object
  System.Web.UI.Adapters.ControlAdapter
    System.Web.UI.WebControls.Adapters.WebControlAdapter
      System.Web.UI.WebControls.Adapters.DataBoundControlAdapter

public class DataBoundControlAdapter : WebControlAdapter

NameDescription
System_CAPS_pubmethodDataBoundControlAdapter()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the DataBoundControlAdapter class.

NameDescription
System_CAPS_protpropertyBrowser

Gets a reference to the browser capabilities of the client making the current HTTP request.(Inherited from ControlAdapter.)

System_CAPS_protpropertyControl

Retrieves a strongly-typed reference to the DataBoundControl object associated with this control adapter.

System_CAPS_protpropertyIsEnabled

Gets a value indicating whether the Web control and all its parent controls are enabled.(Inherited from WebControlAdapter.)

System_CAPS_protpropertyPage

Gets a reference to the page where the control associated with this adapter resides.(Inherited from ControlAdapter.)

System_CAPS_protpropertyPageAdapter

Gets a reference to the page adapter for the page where the associated control resides.(Inherited from ControlAdapter.)

NameDescription
System_CAPS_protmethodBeginRender(HtmlTextWriter)

Called 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.)

System_CAPS_protmethodCreateChildControls()

Creates the target-specific child controls for a composite control.(Inherited from ControlAdapter.)

System_CAPS_protmethodEndRender(HtmlTextWriter)

Called 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.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodLoadAdapterControlState(Object)

Loads 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.)

System_CAPS_protmethodLoadAdapterViewState(Object)

Loads 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.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnInit(EventArgs)

Overrides the OnInit method for the associated control.(Inherited from ControlAdapter.)

System_CAPS_protmethodOnLoad(EventArgs)

Overrides the OnLoad method for the associated control.(Inherited from ControlAdapter.)

System_CAPS_protmethodOnPreRender(EventArgs)

Overrides the OnPreRender method for the associated control.(Inherited from ControlAdapter.)

System_CAPS_protmethodOnUnload(EventArgs)

Overrides the OnUnload method for the associated control.(Inherited from ControlAdapter.)

System_CAPS_protmethodPerformDataBinding(IEnumerable)

Binds the data in the data source of the associated DataBoundControl object to the control adapter.

System_CAPS_protmethodRender(HtmlTextWriter)

Generates the target-specific markup for the control to which the control adapter is attached.(Inherited from WebControlAdapter.)

System_CAPS_protmethodRenderBeginTag(HtmlTextWriter)

Creates the beginning tag for the Web control in the markup that is transmitted to the target browser.(Inherited from WebControlAdapter.)

System_CAPS_protmethodRenderChildren(HtmlTextWriter)

Generates the target-specific markup for the child controls in a composite control to which the control adapter is attached.(Inherited from ControlAdapter.)

System_CAPS_protmethodRenderContents(HtmlTextWriter)

Generates the target-specific inner markup for the Web control to which the control adapter is attached.(Inherited from WebControlAdapter.)

System_CAPS_protmethodRenderEndTag(HtmlTextWriter)

Creates the ending tag for the Web control in the markup that is transmitted to the target browser.(Inherited from WebControlAdapter.)

System_CAPS_protmethodSaveAdapterControlState()

Saves control state information for the control adapter.(Inherited from ControlAdapter.)

System_CAPS_protmethodSaveAdapterViewState()

Saves view state information for the control adapter.(Inherited from ControlAdapter.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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:

using System;
using System.Data;
using System.Web;
using System.Web.UI;
using System.Collections;
using System.Security.Permissions;

namespace MyControls
{
    // MyDataBound control is a simple read-only grid control.
    [AspNetHostingPermission(SecurityAction.Demand,
        Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand,
        Level = AspNetHostingPermissionLevel.Minimal)]
    public class MyDataBound : System.Web.UI.WebControls.DataBoundControl
    {
        // This is an enumerator for the data source.
        IEnumerator dataSourceEnumerator = null;

        // Render the data source as a table, without row and column headers.
        protected override void RenderContents(
            System.Web.UI.HtmlTextWriter writer)
        {
            // Render the <table> tag.
            writer.RenderBeginTag(HtmlTextWriterTag.Table);

            // Render the table rows.
            while (dataSourceEnumerator.MoveNext())
            {
                // Get the next data row as an object array.
                object[] dataArray = 
                    ((DataRowView)dataSourceEnumerator.Current).Row.ItemArray;

                // Render the <tr> tag.
                writer.RenderBeginTag(HtmlTextWriterTag.Tr);

                // Render the fields of the row.
                for(int col = 0; col<dataArray.GetLength(0) ; col++)
                {
                    //Render the <td> tag, the field data and the </td> tag.
                    writer.RenderBeginTag(HtmlTextWriterTag.Td);
                    writer.Write(dataArray[col]);
                    writer.RenderEndTag();
                }
                // Render the </tr> tag.
                writer.RenderEndTag();
            }
            // Render the </table> tag.
            writer.RenderEndTag();
        }

        // Data binding consists of saving an enumerator for the data.
        protected override void PerformDataBinding(IEnumerable data)
        {
            dataSourceEnumerator = data.GetEnumerator();
        }
    }

    // MyDataBoundAdapter modifies a MyDataBound control to display a
    // grid as a list with row separators.
    [AspNetHostingPermission(SecurityAction.Demand,
        Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand,
        Level = AspNetHostingPermissionLevel.Minimal)]
    public class MyDataBoundAdapter :
        System.Web.UI.WebControls.Adapters.DataBoundControlAdapter
    {
        // Returns a strongly-typed reference to the MyDataBound control.
        public new MyDataBound Control
        {
            get
            {
                return (MyDataBound)base.Control;
            }
        }

        // One-dimensional list for the grid data.
        ArrayList dataArray = new ArrayList();

        // Copy grid data to one-dimensional list, add row separators.
        protected override void PerformDataBinding(IEnumerable data)
        {
            IEnumerator dataSourceEnumerator = data.GetEnumerator();

            // Iterate through the table rows.
            while (dataSourceEnumerator.MoveNext())
            {
                // Add the next data row to the ArrayList.
                dataArray.AddRange(
                    ((DataRowView)dataSourceEnumerator.Current).Row.ItemArray);

                // Add a separator to the ArrayList.
                dataArray.Add("----------");
            }
        }

        // Render the data source as a one-dimensional list.
        protected override void RenderContents(
            System.Web.UI.HtmlTextWriter writer)
        {
            // Render the data list.
            for( int col=0; col<dataArray.Count;col++)
            {
                writer.Write(dataArray[col]);
                writer.WriteBreak();
            }
        }
    }
}

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
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft