This documentation is archived and is not being maintained.

WebPartChrome::RenderWebPart Method

Renders a complete WebPart control with all its sections.

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

public:
virtual void RenderWebPart(
	HtmlTextWriter^ writer, 
	WebPart^ webPart
)

Parameters

writer
Type: System.Web.UI::HtmlTextWriter

The HtmlTextWriter that receives the webPart content.

webPart
Type: System.Web.UI.WebControls.WebParts::WebPart

The control currently being rendered.

ExceptionCondition
ArgumentNullException

The control that webPart refers to is nullptr.

The RenderWebPart method renders the complete WebPart control, with header, contents, and footer. Overriding this method gives a developer complete programmatic control over rendering all aspects of webPart, and for that reason, overriding this method is quite complex. As with some other methods in the WebPartChrome class that developers can override, if you override this method, a common and useful approach is to call the base method first, take the WebPart control that is returned, and customize some of its properties, rather than handling the complete rendering yourself.

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
Show: