Control.RenderControl Method (HtmlTextWriter)


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 Overridable Sub RenderControl (
	writer As HtmlTextWriter


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.

' Override default implementation to Render children according to needs. 
      Protected Overrides Sub RenderChildren(output As HtmlTextWriter)
         If HasControls() Then
            ' Render Children in reverse order.
            Dim i As Integer

            For i = Controls.Count - 1 To 0 Step -1

         End If
      End Sub 'RenderChildren

      Protected Overrides Sub Render(output As HtmlTextWriter)
         output.Write(("<br>Message from Control : " + Message))
         output.Write(("Showing Custom controls created in reverse" + "order"))
         ' Render Controls.
      End Sub
   End Class

.NET Framework
Available since 1.1
Return to top