This documentation is archived and is not being maintained.

Button.AddAttributesToRender Method

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Adds the attributes of the Button control to the output stream for rendering on the client.

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

protected override void AddAttributesToRender(
	HtmlTextWriter writer
)

Parameters

writer
Type: System.Web.UI.HtmlTextWriter

An System.Web.UI.HtmlTextWriter that contains the output stream to render on the client.

The following code example demonstrates how to override the AddAttributesToRender method in a custom server control, so that the Button text always displays in red.

<%@ Page language="c#" %>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS.Controls" Assembly="Samples.AspNet.CS" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>Custom Button - AddAttributesToRender - C# Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">
      <h3>Custom Button - AddAttributesToRender - C# Example</h3>

      <aspSample:CustomButtonAddAttributesToRender
        id="Button1"
        runat="server"
        Text="Button" />

    </form>
  </body>
</html>


...


using System.Web;
using System.Security.Permissions;

namespace Samples.AspNet.CS.Controls
{
    [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
    public sealed class CustomButtonAddAttributesToRender : System.Web.UI.WebControls.Button
    {
    protected override void AddAttributesToRender(System.Web.UI.HtmlTextWriter writer) 
    {
      // Add a client-side onclick event to the button.
      writer.AddAttribute(System.Web.UI.HtmlTextWriterAttribute.Onclick, "alert('Hello World');");

      // Update the text of the button to be shown in the color Red
      writer.AddStyleAttribute(System.Web.UI.HtmlTextWriterStyle.Color, "Red");

      // Call the base's AddAttributesToRender method
      base.AddAttributesToRender(writer);
    }
  }
}

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, 1.1, 1.0
Show: