HtmlTextWriter.AddAttribute Method (HtmlTextWriterAttribute, String, Boolean)
Assembly: System.Web (in System.Web.dll)
Public Overridable Sub AddAttribute ( key As HtmlTextWriterAttribute, value As String, fEncode As Boolean )
An HtmlTextWriterAttribute that represents the markup attribute to add to the output stream.
A string containing the value to assign to the attribute.
true to encode the attribute and its value; otherwise, false.
Use theoverload of the 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 themethod 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:
The following code example demonstrates how to use themethod 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 "encoding " required", False) writer.RenderBeginTag(HtmlTextWriterTag.Img) writer.RenderEndTag() writer.WriteLine()
Available since 1.1