CatalogPartChrome.RenderPartContents(HtmlTextWriter, CatalogPart) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Renders the main content area of a CatalogPart control, excluding the header and footer.

protected:
 virtual void RenderPartContents(System::Web::UI::HtmlTextWriter ^ writer, System::Web::UI::WebControls::WebParts::CatalogPart ^ catalogPart);

protected virtual void RenderPartContents (System.Web.UI.HtmlTextWriter writer, System.Web.UI.WebControls.WebParts.CatalogPart catalogPart);

abstract member RenderPartContents : System.Web.UI.HtmlTextWriter * System.Web.UI.WebControls.WebParts.CatalogPart -> unit
override this.RenderPartContents : System.Web.UI.HtmlTextWriter * System.Web.UI.WebControls.WebParts.CatalogPart -> unit

Protected Overridable Sub RenderPartContents (writer As HtmlTextWriter, catalogPart As CatalogPart)

Parameters

writer: HtmlTextWriter

The HtmlTextWriter that receives the catalogPart content.

catalogPart: CatalogPart

The control currently being rendered.

Exceptions

ArgumentNullException

The control that catalogPart refers to is null.

Examples

The following code example demonstrates how to override the RenderPartContents method to add text to the catalog part. For the full code required to run the example, including the Web page to host these controls, see the Example section of the CatalogPartChrome class overview.

protected override void  RenderPartContents(HtmlTextWriter writer, CatalogPart catalogPart)
{
    writer.AddStyleAttribute("color", "red");
    writer.RenderBeginTag("p");
    writer.Write("Apply all changes");
    writer.RenderEndTag();
    catalogPart.RenderControl(writer);
}

Protected Overrides Sub RenderPartContents(ByVal writer As System.Web.UI.HtmlTextWriter, ByVal catalogPart As System.Web.UI.WebControls.WebParts.CatalogPart)
    writer.AddStyleAttribute("color", "red")
    writer.RenderBeginTag("p")
    writer.Write("Apply all changes")
    writer.RenderEndTag()
    catalogPart.RenderControl(writer)
End Sub

Remarks

The RenderPartContents method enables you to override the rendering of the body area of catalogPart, while leaving rendering of the header and footer to the default rendering.

Notes to Inheritors

You can optionally override the RenderPartContents(HtmlTextWriter, CatalogPart) method. If so, you can simply perform whatever rendering customizations you want for catalogPart, and then call its RenderControl(HtmlTextWriter) method.

Applies to