Style.AddAttributesToRender Method (HtmlTextWriter, WebControl)

Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriter and Web server control. This method is primarily used by control developers.

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

public:
virtual void AddAttributesToRender (
	HtmlTextWriter^ writer, 
	WebControl^ owner
)
public void AddAttributesToRender (
	HtmlTextWriter writer, 
	WebControl owner
)
public function AddAttributesToRender (
	writer : HtmlTextWriter, 
	owner : WebControl
)

Parameters

writer

An System.Web.UI.HtmlTextWriter that represents the output stream to render HTML content on the client.

owner

A WebControl or WebControl derived object that represents the Web server control associated with the Style.

To render attributes and styles for a Web server control on the client, you typically call the HtmlTextWriter.AddAttribute and HtmlTextWriter.AddStyleAttribute methods to insert each attribute and style individually to the System.Web.UI.HtmlTextWriter output stream. To simplify the process, this method encapsulates all calls to the HtmlTextWriter.AddAttribute and HtmlTextWriter.AddStyleAttribute methods for every attribute and style associated with the Web Server control. All attributes and styles are inserted into the System.Web.UI.HtmlTextWriter output stream in a single method call. This method is typically overridden by control developers in derived classes to insert the appropriate attributes and styles to the System.Web.UI.HtmlTextWriter output stream for the class.

The following example demonstrates how to create a class that derives from the WebControl class. The base implementation of the AddAttributesToRender method is overridden to add attributes appropriate to the derived class in the System.Web.UI.HtmlTextWriter output stream.

No code example is currently available or this language may not be supported.
package ControlTest; 
import System.*;
import System.Web.UI.*;
import System.Web.UI.WebControls.*;

// Renders the following HTML: 
// <span onclick="alert('Hello');" style="color:Red;">Custom Contents</span>
public class MyWebControl extends WebControl
{
    public MyWebControl()
    {
         super(HtmlTextWriterTag.Span);
    } //MyWebControl

    protected void AddAttributesToRender(HtmlTextWriter writer)
    {
        writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");
        writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red");
        super.AddAttributesToRender(writer);
    } //AddAttributesToRender

    /** @attribute System.Security.Permissions.PermissionSet(System.Security.
        Permissions.SecurityAction.Demand, Name = "FullTrust")
     */
    protected void RenderContents(HtmlTextWriter writer)
    {
        writer.Write("Custom Contents");
        super.RenderContents(writer);
    } //RenderContents
} //MyWebControl

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show: