This documentation is archived and is not being maintained.

HtmlTextWriter.RenderBeforeTag Method

Writes any text or spacing that occurs before the opening tag of a markup element.

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

protected virtual string RenderBeforeTag()

Return Value

Type: System.String
The text or spacing to write before the markup element opening tag. If not overridden, null.

The RenderBeforeTag method can be useful if you want to render additional opening tags before the opening tag of the intended element.

Notes to Implementers

The HtmlTextWriter class implementation of the RenderBeforeTag method returns null. Override RenderBeforeTag if you want to write text or spacing ahead of the element opening tag.

The following code example shows how to override the RenderBeforeTag method to determine whether a class that is derived from the HtmlTextWriter class is about to render a <label> element. If so, the RenderBeforeTag override inserts the opening tag of a <font> element immediately before the <label> element. If it is not rendering a <label> element, the RenderBeforeTag base method is used.

// Override the RenderBeforeTag method to add the 
// opening tag of a Font element before the 
// opening tag of any Label elements rendered by this 
// custom markup writer. 
protected override string RenderBeforeTag()
    // Compare the TagName property value to the
    // string label to determine whether the element to 
    // be rendered is a Label. If it is a Label,
    // the opening tag of the Font element, with a Color
    // style attribute set to red, is added before
    // the Label.
    if (String.Compare(TagName, "label") == 0)
        return "<font color=\"red\">";
    // If a Label is not being rendered, use 
        // the base RenderBeforeTag method.
        return base.RenderBeforeTag();

.NET Framework

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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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