This documentation is archived and is not being maintained.

Control.RenderControl Method (HtmlTextWriter)

Updated: February 2010

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

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

public virtual void RenderControl(
	HtmlTextWriter writer
)

Parameters

writer
Type: System.Web.UI.HtmlTextWriter

The HtmlTextWriter object that receives the control content.

If a server control's Visible property is set to true, this method determines whether tracing is enabled for the page. If so, it stores trace information associated with the control, and renders the server control content to the page.

This method is automatically called by the page during the rendering, but can be overridden by custom control developers.

The following example overrides the RenderChildren method in a custom server control. It determines whether the current control has any child controls in its ControlCollection object. If it does, it uses the Count property to iterate through the collection. As it encounters each child control, it uses the RenderControl method to render the child control, and all of its child controls, to the containing page. The XhtmlTextWriter object that is passed to this method is instantiated by the Render method.

// Override default implementation to Render children according to needs.  
protected override void RenderChildren(HtmlTextWriter output)
{
   if (HasControls())
   {
      // Render Children in reverse order. 
      for(int i = Controls.Count - 1; i >= 0; --i)
      {
         Controls[i].RenderControl(output);
      }
   }         
}

protected override void Render(HtmlTextWriter output)
{       
   output.Write("<br>Message from Control : " + Message);       
   output.Write("Showing Custom controls created in reverse" +
                                                    "order");         
   // Render Controls.
   RenderChildren(output);
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Date

History

Reason

February 2010

Added an explanation of where the HtmlTextWriter object comes from.

Customer feedback.

Show: