AddAttribute Method (HtmlTextWriterAttribute, String)
This documentation is archived and is not being maintained.

HtmlTextWriter.AddAttribute Method (HtmlTextWriterAttribute, String)

Adds the markup attribute and the attribute value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

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

public virtual void AddAttribute(
	HtmlTextWriterAttribute key,
	string value
)

Parameters

key
Type: System.Web.UI.HtmlTextWriterAttribute

An HtmlTextWriterAttribute that represents the markup attribute to add to the output stream.

value
Type: System.String

A string containing the value to assign to the attribute.

Use the AddAttribute overload of the AddAttribute(HtmlTextWriterAttribute, String) method to render a standard markup attribute.

For an instance of any given markup element, the HtmlTextWriter class maintains a list of attributes for that element. When the RenderBeginTag method is called, any attributes that are added by the AddAttribute method are rendered to the opening tag of the element. The list of attributes is then cleared from the HtmlTextWriter.

The coding pattern for rendering markup elements is as follows:

  • Use the AddAttribute method to add any attributes to the element.

  • Use the RenderBeginTag method.

  • Use other methods as needed to render the content found between the element's opening and closing tags.

  • Use the RenderEndTag method.

The following code example shows how to use the AddAttribute overload of the AddAttribute(HtmlTextWriterAttribute, String) method to add an Onclick attribute to a markup element, and then set its value to the following ECMAScript code:

alert('Hello');
writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");

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:
© 2016 Microsoft