mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.Adapters/DataBoundControlAdapter.xml Normal file
View File

@@ -0,0 +1,96 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="DataBoundControlAdapter" FullName="System.Web.UI.WebControls.Adapters.DataBoundControlAdapter">
<TypeSignature Language="C#" Value="public class DataBoundControlAdapter : System.Web.UI.WebControls.Adapters.WebControlAdapter" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.Adapters.WebControlAdapter</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A control derived from the <see cref="T:System.Web.UI.WebControls.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. <see cref="T:System.Web.UI.WebControls.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 <see cref="T:System.Web.UI.WebControls.DataGrid" /> and <see cref="T:System.Web.UI.WebControls.ListBox" /> controls. For more information, see <see cref="T:System.Web.UI.WebControls.DataBoundControl" />.</para>
<para>A <see cref="T:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter" /> modifies the behavior of a <see cref="T:System.Web.UI.WebControls.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 <see cref="T:System.Web.UI.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 <see cref="T:System.Web.UI.HtmlTextWriter" /> classes can make the use of a control adapter unnecessary.</para>
<para>Each control has explicit mappings to adapters through the .browser definition files, if there are &lt;controlAdapter&gt; entries in these files. Thus, any access to the <see cref="P:System.Web.UI.Control.Adapter" /> property of the <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> uses the <see cref="T:System.Web.HttpBrowserCapabilities" /> object extracted from the .browser definition files to perform the lookup for the mapping of the adapter to control.</para>
<para>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 <see cref="T:System.Web.UI.Adapters.ControlAdapter" />.</para>
<para>The M:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter.PerformDataBinding(System.Collections.IEnumerable) method binds an enumerable collection to the associated <see cref="T:System.Web.UI.WebControls.DataBoundControl" />. The <see cref="P:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter.Control" /> property returns a strongly typed reference to the <see cref="T:System.Web.UI.WebControls.DataBoundControl" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Customizes the behavior of a <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> object with which the adapter is associated for specific browser requests.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataBoundControlAdapter ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter" /> class when it creates the corresponding <see cref="T:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter" /> object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Control">
<MemberSignature Language="C#" Value="protected System.Web.UI.WebControls.DataBoundControl Control { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.DataBoundControl</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a <see cref="T:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter" /> object is attached to a <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> control, the .NET Framework calls certain adapter members instead of the control members. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a strongly-typed reference to the <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> object associated with this control adapter.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PerformDataBinding">
<MemberSignature Language="C#" Value="protected virtual void PerformDataBinding (System.Collections.IEnumerable data);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Collections.IEnumerable" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter.PerformDataBinding(System.Collections.IEnumerable)" /> method is called in place of the <see cref="M:System.Web.UI.WebControls.DataBoundControl.PerformDataBinding(System.Collections.IEnumerable)" /> method when a <see cref="T:System.Web.UI.WebControls.Adapters.DataBoundControlAdapter" /> control adapter is attached to a control derived from the <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> class.</para>
<para>Typically, an override of <see cref="M:System.Web.UI.WebControls.DataBoundControl.PerformDataBinding(System.Collections.IEnumerable)" /> iterates through data, creating distinct names and values when necessary, and saves it to an internal collection. Usually, <see cref="M:System.Web.UI.WebControls.WebControl.RenderContents(System.Web.UI.HtmlTextWriter)" /> or a similar method of the <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> will populate the user interface or child controls from that internal collection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Binds the data in the data source of the associated <see cref="T:System.Web.UI.WebControls.DataBoundControl" /> object to the control adapter.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IEnumerable" /> of <see cref="T:System.Object" /> to be bound to the derived <see cref="T:System.Web.UI.WebControls.DataBoundControl" />.</param>
</Docs>
</Member>
</Members>
</Type>

75
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.Adapters/HideDisabledControlAdapter.xml Normal file
View File

@@ -0,0 +1,75 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HideDisabledControlAdapter" FullName="System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter">
<TypeSignature Language="C#" Value="public class HideDisabledControlAdapter : System.Web.UI.WebControls.Adapters.WebControlAdapter" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.Adapters.WebControlAdapter</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter" /> class adapts the associated <see cref="T:System.Web.UI.WebControls.WebControl" /> control to modify the default markup or behavior for a specific browser. You can extend the <see cref="T:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter" /> class to further customize rendering of the <see cref="T:System.Web.UI.WebControls.WebControl" /> control. </para>
<para>Adapters are compiled .NET Framework components that take over one or more stages in the life cycle of a page or control. Extending the <see cref="T:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter" /> class will provide access to the life-cycle stages of the <see cref="T:System.Web.UI.WebControls.WebControl" /> control. For more information, see <format type="text/html"><a href="4ff05ae9-4109-4352-929e-ad893895dbff">Architectural Overview of Adaptive Control Behavior</a></format>.</para>
<para>The initial request for an adapter causes the .NET Framework to search for a mapped adapter for the control given the characteristics of the requesting browser. Browser definition files are used by the <see cref="T:System.Web.HttpBrowserCapabilities" /> class to identify the characteristics of the client browser and map the adapter to the browser type. For more information, see <format type="text/html"><a href="4ff05ae9-4109-4352-929e-ad893895dbff">Architectural Overview of Adaptive Control Behavior</a></format>.</para>
<para>For a description of the adaptive rendering architecture of ASP.NET and a step-by-step walkthrough that shows how to implement a control adapter and map it to a control, see "Authoring ASP.NET Server Control Adapters: An Introduction" in the MSDN Library at <see cref="http://msdn.microsoft.com/library">http://msdn.microsoft.com/library</see>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides rendering capabilities for the associated Web control to modify the default markup or behavior for a specific browser.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HideDisabledControlAdapter ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The .NET Framework constructs an instance of the <see cref="T:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter" /> class. The initial request for an adapter causes the .NET Framework to search for a mapped adapter for the control given the characteristics of the requesting browser. Once found, the control holds a reference to the mapped adapter instance in its <see cref="P:System.Web.UI.Control.Adapter" /> property. For information on adapter mappings and browser definition files, see <format type="text/html"><a href="4ff05ae9-4109-4352-929e-ad893895dbff">Architectural Overview of Adaptive Control Behavior</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="protected override void Render (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> method writes the associated <see cref="T:System.Web.UI.WebControls.WebControl" /> control to the output stream as HTML. </para>
<para>By default, the .NET Framework calls on the Web server control's own <see cref="M:System.Web.UI.Control.Render(System.Web.UI.HtmlTextWriter)" /> method. However, once the <see cref="P:System.Web.UI.Control.Adapter" /> property of that control is set, the .NET Framework will execute the adapter's implementation of the <see cref="M:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> event over that of the associated control.</para>
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> event is used to perform modifications to the markup code that is rendered to a device browser. Control properties should be set prior to this phase of the life cycle and only the actual markup creation for the control done here. Changes made to the control in this stage of the life cycle are not saved to view state. For saving changes made to the control, override the <see cref="M:System.Web.UI.Adapters.ControlAdapter.OnPreRender(System.EventArgs)" /> event.</para>
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.HideDisabledControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> event also allows derived classes to handle the event without attaching a delegate, which is the preferred technique for handling the event in a derived class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes the associated Web control to the output stream as HTML.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> containing methods to build and render the device-specific output. </param>
</Docs>
</Member>
</Members>
</Type>

90
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.Adapters/HierarchicalDataBoundControlAdapter.xml Normal file
View File

@@ -0,0 +1,90 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HierarchicalDataBoundControlAdapter" FullName="System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter">
<TypeSignature Language="C#" Value="public class HierarchicalDataBoundControlAdapter : System.Web.UI.WebControls.Adapters.WebControlAdapter" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.Adapters.WebControlAdapter</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter" /> class adapts the associated <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control to modify the default markup or behavior for a specific browser. You can extend the <see cref="T:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter" /> class to further customize rendering of the <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control. </para>
<para>A <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control is bound to a data source and generates its user interface (or child control hierarchy, typically), by enumerating the items in the data source to which it is bound. For more information on hierarchical data-bound controls, see <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" />.</para>
<para>Control adapters are.NET components that manage one or more stages in the life cycle of a control for a specific browser. Extending the <see cref="T:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter" /> class provides access to the life-cycle stages of the <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control. For more information, see <format type="text/html"><a href="4ff05ae9-4109-4352-929e-ad893895dbff">Architectural Overview of Adaptive Control Behavior</a></format>.</para>
<para>The initial request for an adapter causes the .NET Framework to search for a mapped adapter for the control, given the characteristics of the requesting browser. Browser definition files are used by the <see cref="T:System.Web.HttpBrowserCapabilities" /> class to identify the characteristics of the client browser and map the adapter to the browser type. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Customizes the behavior of a <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> object with which this control adapter is associated, for specific browser requests.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HierarchicalDataBoundControlAdapter ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The .NET Framework constructs an instance of the <see cref="T:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter" /> class. The initial request for an adapter causes the .NET Framework to search for a mapped adapter for the control given the characteristics of the requesting browser. After the adapter is found, the control holds a reference to the mapped adapter instance in its <see cref="P:System.Web.UI.Control.Adapter" /> property. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Control">
<MemberSignature Language="C#" Value="protected System.Web.UI.WebControls.HierarchicalDataBoundControl Control { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.HierarchicalDataBoundControl</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter.Control" /> property provides access to the corresponding control, including its properties and methods.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a strongly typed reference to the <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control associated with this <see cref="T:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter" /> object.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PerformDataBinding">
<MemberSignature Language="C#" Value="protected virtual void PerformDataBinding ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter.PerformDataBinding" /> method binds the data in the specified data source of the associated <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control to the <see cref="T:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter" /> object. You can override <see cref="M:System.Web.UI.WebControls.Adapters.HierarchicalDataBoundControlAdapter.PerformDataBinding" /> to replace the standard data-binding functionality of the associated <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control or to provide additional data-binding functionality if the associated <see cref="T:System.Web.UI.WebControls.HierarchicalDataBoundControl" /> control has been extended. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Binds the data in the data source of the associated hierarchical data-bound control to the adapter.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

349
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.Adapters/MenuAdapter.xml Normal file
View File

@@ -0,0 +1,349 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="MenuAdapter" FullName="System.Web.UI.WebControls.Adapters.MenuAdapter">
<TypeSignature Language="C#" Value="public class MenuAdapter : System.Web.UI.WebControls.Adapters.WebControlAdapter, System.Web.UI.IPostBackEventHandler" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.Adapters.WebControlAdapter</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.UI.IPostBackEventHandler</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Web.UI.WebControls.Adapters.MenuAdapter" /> modifies the markup or behavior of a <see cref="T:System.Web.UI.WebControls.Menu" /> control for a specific browser or class of browsers, or acts as a filter on some capability.</para>
<para>By default, the <see cref="T:System.Web.UI.WebControls.MenuItem" /> objects in the <see cref="T:System.Web.UI.WebControls.Menu" /> control are rendered as hyperlinks to accommodate menu navigation. The <see cref="T:System.Web.UI.WebControls.Menu" /> class maintains state by implementing the <see cref="T:System.Web.UI.IPostBackEventHandler" /> interface so that it can respond to and raise specific events during postback. You can extend the <see cref="T:System.Web.UI.WebControls.Adapters.MenuAdapter" /> class to further customize rendering or behavior of the <see cref="T:System.Web.UI.WebControls.Menu" /> control. </para>
<para>The initial request for an adapter causes the .NET Framework to search for a mapped adapter for the control, given the characteristics of the requesting browser. The <see cref="T:System.Web.HttpBrowserCapabilities" /> class uses browser definition files to identify the characteristics of the client browser and to map the adapter to the browser type.</para>
<para>For more information about adaptive rendering in ASP.NET, see <format type="text/html"><a href="4ff05ae9-4109-4352-929e-ad893895dbff">Architectural Overview of Adaptive Control Behavior</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the means to modify the behavior of the <see cref="T:System.Web.UI.WebControls.Menu" /> control for specific browsers.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MenuAdapter ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The initial request for an adapter causes the .NET Framework to search for a mapped adapter for the control, given the characteristics of the requesting browser. After the adapter is found, the control holds a reference to the mapped adapter instance in its <see cref="P:System.Web.UI.Control.Adapter" /> property. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.Adapters.MenuAdapter" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Control">
<MemberSignature Language="C#" Value="protected System.Web.UI.WebControls.Menu Control { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.Menu</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.Adapters.MenuAdapter.Control" /> property provides a way to reference the adapter's corresponding control. When an adapter is associated with a particular control, the .NET Framework will call the life-cycle methods of the adapter in place of or in addition to the life-cycle methods of the control.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a strongly typed reference to the <see cref="T:System.Web.UI.WebControls.Menu" /> control associated with this <see cref="T:System.Web.UI.WebControls.Adapters.MenuAdapter" /> object.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="LoadAdapterControlState">
<MemberSignature Language="C#" Value="protected override void LoadAdapterControlState (object state);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When an adapter needs to maintain private state information, it can override the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.LoadAdapterControlState(System.Object)" /> and <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.SaveAdapterControlState" /> methods. In the case of the <see cref="T:System.Web.UI.WebControls.Adapters.MenuAdapter" /> class, where the displayed menu hierarchy is dependent on the previously selected <see cref="T:System.Web.UI.WebControls.MenuItem" /> object, <paramref name="state" /> provides a dictionary of name/value pairs containing the path of the selected item in the menu's hierarchy. The <paramref name="state" /> parameter is a <see cref="T:System.Web.UI.Pair" /> object saved by the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.SaveAdapterControlState" /> during a previous request to the page.</para>
<para>If the control is not registered to participate in control state, the adapter must register for control state. Adapter control state is maintained in addition to the state for the control, unlike other life-cycle methods.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Loads any control state information that was saved by the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.SaveAdapterControlState" /> method during a previous request to the page.</para>
</summary>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> in the form of a dictionary that contains the adapter's state information.</param>
</Docs>
</Member>
<Member MemberName="OnInit">
<MemberSignature Language="C#" Value="protected override void OnInit (EventArgs e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="e" Type="System.EventArgs" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.OnInit(System.EventArgs)" /> method registers the associated control as one that requires control state. By default, the .NET Framework calls the Web server control's own <see cref="M:System.Web.UI.Control.OnInit(System.EventArgs)" /> method. However, after the <see cref="P:System.Web.UI.Control.Adapter" /> property of the server control is set, the .NET Framework will call the adapter's implementation of the <see cref="M:System.Web.UI.Control.OnInit(System.EventArgs)" /> method instead of the control's implementation.</para>
<para>Use the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.OnInit(System.EventArgs)" /> method to initialize settings in the control. During a postback, this is an important phase for managing interaction with existing view-state data. For more information, see <format type="text/html"><a href="4ff05ae9-4109-4352-929e-ad893895dbff">Architectural Overview of Adaptive Control Behavior</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Registers the associated <see cref="T:System.Web.UI.WebControls.Menu" /> control as one that requires control state.</para>
</summary>
<param name="e">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.EventArgs" /> data associated with this event.</param>
</Docs>
</Member>
<Member MemberName="OnPreRender">
<MemberSignature Language="C#" Value="protected override void OnPreRender (EventArgs e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="e" Type="System.EventArgs" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.OnPreRender(System.EventArgs)" /> method calls an internal OnPreRender method in the <see cref="T:System.Web.UI.WebControls.Menu" /> class. All other pre-rendering functions of the parent classes, such as data binding, applying styles, and event assignments perform as expected.</para>
<para>By default, the .NET Framework calls the <see cref="T:System.Web.UI.WebControls.Menu" /> control's <see cref="M:System.Web.UI.WebControls.Menu.OnPreRender(System.EventArgs)" /> method. However, after the <see cref="P:System.Web.UI.Control.Adapter" /> property of that control is set, the .NET Framework will call the adapter's implementation of the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.OnPreRender(System.EventArgs)" /> method instead of the control's implementation.</para>
<para>Use the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.OnPreRender(System.EventArgs)" /> method to finalize any settings in the control. Changes made to control properties in this phase will be saved to view state, but changes made in the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> method are not saved. For more information, see <format type="text/html"><a href="4ff05ae9-4109-4352-929e-ad893895dbff">Architectural Overview of Adaptive Control Behavior</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="M:System.Web.UI.Control.OnPreRender(System.EventArgs)" /> method for the associated <see cref="T:System.Web.UI.WebControls.Menu" /> control.</para>
</summary>
<param name="e">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.EventArgs" /> data associated with this event.</param>
</Docs>
</Member>
<Member MemberName="RaisePostBackEvent">
<MemberSignature Language="C#" Value="protected virtual void RaisePostBackEvent (string eventArgument);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eventArgument" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RaisePostBackEvent(System.String)" /> method is called when the <see cref="M:System.Web.UI.IPostBackEventHandler.RaisePostBackEvent(System.String)" /> event is raised, and is used to maintain the navigation path of the menu. The <paramref name="eventArgument" /> parameter contains a delimited string of menu items that identify the current location in the menu hierarchy. </para>
<para>The page passes the value of <paramref name="eventArgument" /> to the associated control's <see cref="M:System.Web.UI.WebControls.Menu.RaisePostBackEvent(System.String)" /> method. The associated <see cref="T:System.Web.UI.WebControls.Menu" /> control also renders the markup element that causes the postback to occur. If the control renders client-side script for postback, the argument from the script is passed in the <paramref name="eventArgument" /> parameter. If the postback is caused by a simple submit, <paramref name="eventArgument" /> is null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Used to maintain the path of the menu when a postback event is raised.</para>
</summary>
<param name="eventArgument">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that represents the path of the current node in the menu hierarchy.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RenderBeginTag">
<MemberSignature Language="C#" Value="protected override void RenderBeginTag (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> method adds tag attributes and writes the markup for the opening tag of the control to the output stream emitted to the response stream for the client browser. The <see cref="T:System.Web.UI.WebControls.MenuItem" /> objects will be rendered individually in the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method and the control will be closed with a call to the subsequent <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method.</para>
<para>Override <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> when you want to implement custom behavior. For example, override the method to write multiple tags to the response stream before any control content, such as &lt;table&gt;&lt;tr&gt;&lt;td&gt;. Use the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> method in conjunction with the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method to assure opening and closing tag consistency in your output.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds tag attributes and writes the markup for the opening tag of the control to the output stream emitted to the browser or device.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> instance containing methods to build and render the device-specific output.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RenderContents">
<MemberSignature Language="C#" Value="protected override void RenderContents (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method writes the <see cref="T:System.Web.UI.WebControls.MenuItem" /> objects of the associated <see cref="T:System.Web.UI.WebControls.Menu" /> control to the output stream as hyperlinks. The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method is called from the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> method and is used to perform modifications to the markup code that is rendered to a device browser.</para>
<para>Control properties should be set prior to this phase of the life cycle, and only the actual markup creation for the control done here. Changes made to the control in this stage of the life cycle are not saved to view state. For saving changes made to the control, override the <see cref="M:System.Web.UI.Control.OnPreRender(System.EventArgs)" /> event.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes the associated menu items in the associated <see cref="T:System.Web.UI.WebControls.Menu" /> control to the output stream as a series of hyperlinks.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> containing methods to build and render the device-specific output.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RenderEndTag">
<MemberSignature Language="C#" Value="protected override void RenderEndTag (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method writes the markup for the closing tag of the control to the output stream emitted to the response stream for the client browser. The attributes, style attributes, and opening tag are rendered in the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> method. The <see cref="T:System.Web.UI.WebControls.MenuItem" /> objects are rendered individually in the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method.</para>
<para>Override <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> when you want to implement custom behavior. For example, override the method to write multiple closing tags to the response stream after any control content, such as &lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;. Use the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method in conjunction with the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> method to assure opening and closing tag consistency in your output.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates final markup and writes the markup for the closing tag of the control to the output stream emitted to the browser or device.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> instance containing methods to build and render the device-specific output.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RenderItem">
<MemberSignature Language="C#" Value="protected virtual void RenderItem (System.Web.UI.HtmlTextWriter writer, System.Web.UI.WebControls.MenuItem item, int position);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
<Parameter Name="item" Type="System.Web.UI.WebControls.MenuItem" />
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderItem(System.Web.UI.HtmlTextWriter,System.Web.UI.WebControls.MenuItem,System.Int32)" /> method is called from the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method to retrieve the styles and spacing attributes from the <see cref="T:System.Web.UI.WebControls.MenuItem" /> object and apply them to a newly created hyperlink element. The menu hierarchy is traversed in the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method and will call the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.RenderItem(System.Web.UI.HtmlTextWriter,System.Web.UI.WebControls.MenuItem,System.Int32)" /> method to render each item. Each item is rendered as a hyperlink and inherits the properties and styles of the specified <see cref="T:System.Web.UI.WebControls.MenuItem" /> control. The hyperlink rendered to the page is one of the following:</para>
<list type="bullet">
<item>
<para>A postback event to open or select the item.</para>
</item>
<item>
<para>A link to navigate to the target specified in the <see cref="P:System.Web.UI.WebControls.MenuItem.NavigateUrl" /> property of the <see cref="T:System.Web.UI.WebControls.MenuItem" /> control.</para>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Renders a single menu item as a hyperlink.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> instance containing methods to build and render the device-specific output.</param>
<param name="item">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.MenuItem" /> object containing the properties to write to the response stream. </param>
<param name="position">
<attribution license="cc4" from="Microsoft" modified="false" />The position of the specified <see cref="T:System.Web.UI.WebControls.MenuItem" /> object in the menu hierarchy.</param>
</Docs>
</Member>
<Member MemberName="SaveAdapterControlState">
<MemberSignature Language="C#" Value="protected override object SaveAdapterControlState ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.SaveAdapterControlState" /> method uses the <see cref="T:System.Web.UI.WebControls.Menu" /> control state to maintain the current navigation path of the menu. When an adapter needs to maintain private state information, it can override the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.LoadAdapterControlState(System.Object)" /> and <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.SaveAdapterControlState" /> methods. An adapter might maintain private control state when there are complex features that need to maintain state across requests, separate from the associated control's state. The adapter needs to register for control state during the <see cref="M:System.Web.UI.WebControls.Adapters.MenuAdapter.OnInit(System.EventArgs)" /> method call in every request.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Saves any changes to the adapter private control state that have occurred since the page was posted back to the server.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Object" /> that contains the adapter's control state information as a <see cref="T:System.Web.UI.StateBag" />.</para>
</returns>
</Docs>
</Member>
<Member MemberName="System.Web.UI.IPostBackEventHandler.RaisePostBackEvent">
<MemberSignature Language="C#" Value="void IPostBackEventHandler.RaisePostBackEvent (string eventArgument);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eventArgument" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.IPostBackEventHandler.RaisePostBackEvent(System.String)" /> method enables the <see cref="T:System.Web.UI.WebControls.Adapters.MenuAdapter" /> class to process an event that is raised when a page is posted back to the server. The page passes <paramref name="eventArgument" /> to the <see cref="M:System.Web.UI.IPostBackEventHandler.RaisePostBackEvent(System.String)" /> method. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Enables the <see cref="T:System.Web.UI.WebControls.Adapters.MenuAdapter" /> class to process an event raised when a page is posted back to the server.</para>
</summary>
<param name="eventArgument">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains an optional event argument to pass to the event handler.</param>
</Docs>
</Member>
</Members>
</Type>

230
mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls.Adapters/WebControlAdapter.xml Normal file
View File

@@ -0,0 +1,230 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="WebControlAdapter" FullName="System.Web.UI.WebControls.Adapters.WebControlAdapter">
<TypeSignature Language="C#" Value="public class WebControlAdapter : System.Web.UI.Adapters.ControlAdapter" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Adapters.ControlAdapter</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.WebControl" /> class is the base class from which Web controls inherit. It defines many properties common to all Web controls. For more information, see <see cref="T:System.Web.UI.WebControls.WebControl" />.</para>
<para>A <see cref="T:System.Web.UI.WebControls.Adapters.WebControlAdapter" /> object is a component that substitutes certain <see cref="T:System.Web.UI.WebControls.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 <see cref="T:System.Web.UI.WebControls.WebControl" /> object for each client request. </para>
<para>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 <see cref="T:System.Web.UI.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 <see cref="T:System.Web.UI.HtmlTextWriter" /> classes might make the use of a control adapter unnecessary.</para>
<para>Controls themselves do not necessarily require an adapter. If controls are extended through composition, generally the adapters for the child controls are sufficient.</para>
<para>Each control has explicit mappings to adapters through the .browser definition files. Thus, any access to the <see cref="P:System.Web.UI.Control.Adapter" /> property of <see cref="T:System.Web.UI.WebControls.WebControl" /> uses the <see cref="T:System.Web.HttpBrowserCapabilities" /> object extracted from the .browser definition files to perform the lookup for the mapping of the adapter to control.</para>
<para>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 <see cref="T:System.Web.UI.Adapters.ControlAdapter" />.</para>
<para>The rendering for a <see cref="T:System.Web.UI.WebControls.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 <see cref="T:System.Web.UI.WebControls.WebControl" /> is created. For more information, see <see cref="Overload:System.Web.UI.WebControls.WebControl.#ctor" />. </para>
<para>The tags are generated by the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> and <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> methods, respectively. The inner markup is generated by the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method. </para>
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> method generates all markup, by calling methods in the following order: </para>
<list type="ordered">
<item>
<para>
<see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" />.</para>
</item>
<item>
<para>
<see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" />.</para>
</item>
<item>
<para>
<see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" />.</para>
</item>
</list>
<para>The <see cref="P:System.Web.UI.WebControls.Adapters.WebControlAdapter.IsEnabled" /> property returns true only if the <see cref="T:System.Web.UI.WebControls.WebControl" /> and all its parent controls are enabled. The <see cref="P:System.Web.UI.WebControls.Adapters.WebControlAdapter.Control" /> property returns a strongly typed reference to the <see cref="T:System.Web.UI.WebControls.WebControl" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Customizes rendering for the Web control to which the control adapter is attached, to modify the default markup or behavior for specific browsers.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebControlAdapter ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The .NET Framework internally constructs a new instance of the <see cref="T:System.Web.UI.WebControls.Adapters.WebControlAdapter" /> class when it creates the corresponding <see cref="T:System.Web.UI.WebControls.WebControl" /> object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.Adapters.WebControlAdapter" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Control">
<MemberSignature Language="C#" Value="protected System.Web.UI.WebControls.WebControl Control { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.WebControl</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a <see cref="T:System.Web.UI.WebControls.Adapters.WebControlAdapter" /> object is attached to a <see cref="T:System.Web.UI.WebControls.WebControl" /> object, the .NET Framework calls on the adapter life-cycle methods instead of the control methods. For more information, see <see cref="T:System.Web.UI.Adapters.ControlAdapter" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a reference to the Web control to which this control adapter is attached.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsEnabled">
<MemberSignature Language="C#" Value="protected bool IsEnabled { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.Adapters.WebControlAdapter.IsEnabled" /> property provides access for the adapter and any of its derived classes to the <see cref="P:System.Web.UI.WebControls.WebControl.IsEnabled" /> property. <see cref="P:System.Web.UI.WebControls.WebControl.IsEnabled" /> scans the hierarchy of parent controls and returns true only if the Web control and all its parents are enabled.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the Web control and all its parent controls are enabled.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="protected override void Render (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> method generates target-specific markup to send to the client browser. <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.Render(System.Web.UI.HtmlTextWriter)" /> is called in place of the <see cref="M:System.Web.UI.WebControls.WebControl.Render(System.Web.UI.HtmlTextWriter)" /> method if a <see cref="T:System.Web.UI.WebControls.Adapters.WebControlAdapter" /> object is attached to a <see cref="T:System.Web.UI.WebControls.WebControl" /> object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Generates the target-specific markup for the control to which the control adapter is attached.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> containing methods to render the target-specific output. </param>
</Docs>
</Member>
<Member MemberName="RenderBeginTag">
<MemberSignature Language="C#" Value="protected virtual void RenderBeginTag (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Override the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> method to write additional markup tags or add attributes to the beginning tag for the <see cref="T:System.Web.UI.WebControls.WebControl" /> object. Use <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> in conjunction with the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method to assure beginning and ending tag consistency.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates the beginning tag for the Web control in the markup that is transmitted to the target browser.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> containing methods to render the target-specific output. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RenderContents">
<MemberSignature Language="C#" Value="protected virtual void RenderContents (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> method generates the inner markup, between the beginning and ending tags for the control. Typically, markup is generated by <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.Render(System.Web.UI.HtmlTextWriter)" />, which calls methods in the following order:</para>
<list type="ordered">
<item>
<para>
<see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" />.</para>
</item>
<item>
<para>
<see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" />.</para>
</item>
<item>
<para>
<see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" />.</para>
</item>
</list>
<para> Override <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> to generate target-specific inner markup to send to the client browser. </para>
<para>The <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> base method calls <see cref="M:System.Web.UI.WebControls.WebControl.RenderContents(System.Web.UI.HtmlTextWriter)" />. The <see cref="M:System.Web.UI.WebControls.WebControl.RenderContents(System.Web.UI.HtmlTextWriter)" /> base method calls <see cref="M:System.Web.UI.Control.Render(System.Web.UI.HtmlTextWriter)" />, which in turn calls <see cref="M:System.Web.UI.Control.RenderChildren(System.Web.UI.HtmlTextWriter)" />. Thus, overrides of <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> should call the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderContents(System.Web.UI.HtmlTextWriter)" /> base method only if its processing is in addition to, rather than instead of, <see cref="M:System.Web.UI.Control.Render(System.Web.UI.HtmlTextWriter)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Generates the target-specific inner markup for the Web control to which the control adapter is attached.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> containing methods to render the target-specific output. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RenderEndTag">
<MemberSignature Language="C#" Value="protected virtual void RenderEndTag (System.Web.UI.HtmlTextWriter writer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Override the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method to write additional markup tags or add attributes to the ending tag for the <see cref="T:System.Web.UI.WebControls.WebControl" /> object. Use <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> in conjunction with the <see cref="M:System.Web.UI.WebControls.Adapters.WebControlAdapter.RenderBeginTag(System.Web.UI.HtmlTextWriter)" /> method to assure beginning and ending tag consistency.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates the ending tag for the Web control in the markup that is transmitted to the target browser.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> containing methods to render the target-specific output. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>