Control.RenderControl Method (HtmlTextWriter)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

abstract RenderControl : 
        writer:HtmlTextWriter -> unit
override RenderControl : 
        writer:HtmlTextWriter -> unit

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 M:System.Web.UI.Page.Render method.

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

.NET Framework
Available since 1.1
Return to top
Show: