HtmlTextWriter.AddAttribute Method (HtmlTextWriterAttribute, String, Boolean)

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, with optional encoding.

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

public virtual void AddAttribute (
	HtmlTextWriterAttribute key,
	string value,
	bool fEncode
)
public void AddAttribute (
	HtmlTextWriterAttribute key, 
	String value, 
	boolean fEncode
)
public function AddAttribute (
	key : HtmlTextWriterAttribute, 
	value : String, 
	fEncode : boolean
)
Not applicable.

Parameters

key

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

value

A string containing the value to assign to the attribute.

fEncode

true to encode the attribute and its value; otherwise, false.

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

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 added by the AddAttribute are rendered to the opening tag of the element. The list of attributes is then cleared from the HtmlTextWriter object.

Use the AddAttribute(HtmlTextWriterAttribute,String,Boolean) method with fEncode set to true, if the attribute can possibly contain a quotation mark ("), a less than sign (<), or an ampersand (&). The method call will encode the attribute to meet the requirements of the requesting device. You can set fEncode to false, if you know that none of these characters will be generated, or if you know that the attribute is already encoded.

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 demonstrates how to use the AddAttribute(HtmlTextWriterAttribute,String,Boolean) method to ensure that the string value that is assigned to an Alt attribute for an <img> element is encoded for the requesting device.

// Control the encoding of attributes. 
// Simple known values do not need encoding.
writer.AddAttribute(HtmlTextWriterAttribute.Alt, "Encoding, \"Required\"", true);
writer.AddAttribute("myattribute", "No &quot;encoding &quot; required", false);
writer.RenderBeginTag(HtmlTextWriterTag.Img);
writer.RenderEndTag();
writer.WriteLine();

// Control the encoding of attributes. 
// Simple known values do not need encoding.
writer.AddAttribute(HtmlTextWriterAttribute.Alt,
    "Encoding, \"Required\"", true);
writer.AddAttribute("myattribute",
    "No &quot;encoding &quot; required", false);
writer.RenderBeginTag(HtmlTextWriterTag.Img);
writer.RenderEndTag();
writer.WriteLine();

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show: