WebControlAdapter Class

WebControlAdapter Class

 

Customizes rendering for the Web control to which the control adapter is attached, to modify the default markup or behavior for specific browsers.

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


public class WebControlAdapter : ControlAdapter

NameDescription
System_CAPS_pubmethodWebControlAdapter()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the WebControlAdapter 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

Gets a reference to the Web control to which this control adapter is attached.

System_CAPS_protpropertyIsEnabled

Gets a value indicating whether the Web control and all its parent controls are enabled.

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_protmethodRender(HtmlTextWriter)

Generates the target-specific markup for the control to which the control adapter is attached.(Overrides ControlAdapter.Render(HtmlTextWriter).)

System_CAPS_protmethodRenderBeginTag(HtmlTextWriter)

Creates the beginning tag for the Web control in the markup that is transmitted to the target browser.

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.

System_CAPS_protmethodRenderEndTag(HtmlTextWriter)

Creates the ending tag for the Web control in the markup that is transmitted to the target browser.

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

The WebControl class is the base class from which Web controls inherit. It defines many properties common to all Web controls. For more information, see WebControl.

A WebControlAdapter object is a component that substitutes certain WebControl class or inherited methods and events in its execution life cycle to allow browser- or markup-specific handling. The .NET Framework maps a single control adapter to a derived WebControl object for each client request.

An adapter modifies a control behavior for a specific browser or class of browsers or acts as an arbitrary 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 might make the use of a control adapter unnecessary.

Controls themselves do not necessarily require an adapter. If controls are extended through composition, generally the adapters for the child controls are sufficient.

Each control has explicit mappings to adapters through the .browser definition files. Thus, any access to the Adapter property of WebControl 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 overridable methods of a control that could be target-specific. If a control adapter is attached, the .NET Framework calls the associated adapter methods. For more information, see ControlAdapter.

The rendering for a WebControl typically consists of a beginning and ending tag, and some inner markup between the beginning and ending tags. The tags are defined when the WebControl is created. For more information, see WebControl.

The tags are generated by the RenderBeginTag and RenderEndTag methods, respectively. The inner markup is generated by the RenderContents method.

The Render method generates all markup, by calling methods in the following order:

  1. RenderBeginTag.

  2. RenderContents.

  3. RenderEndTag.

The IsEnabled property returns true only if the WebControl and all its parent controls are enabled. The Control property returns a strongly typed reference to the WebControl.

.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