HtmlTextWriter.EncodeAttributeValue Method (String, Boolean)

 

Encodes the value of the specified markup attribute based on the requirements of the HttpRequest object of the current context.

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

protected string EncodeAttributeValue(
	string value,
	bool fEncode
)

Parameters

value
Type: System.String

A string containing the attribute value to encode.

fEncode
Type: System.Boolean

true to encode the attribute value; otherwise, false.

Return Value

Type: System.String

A string containing the encoded attribute value, null if value is empty, or the unencoded attribute value if fEncode is false.

Use the EncodeAttributeValue overload of the EncodeAttributeValue(HtmlTextWriterAttribute, String) method if the attribute is not an HtmlTextWriterAttribute enumeration value or is not known until run time.

The EncodeAttributeValue method removes double quotation marks ("), ampersands (&), and less than signs (<) so that invalid tags are not generated, regardless of the input. The actual encoding is performed by the HtmlAttributeEncode method.

The following code example shows how to call the EncodeAttributeValue method as a parameter in an AddAttribute method call, and then encodes a color:blue style attribute value.

// If the <label> element is rendered and a style
// attribute is not defined, add a style attribute 
// and set its value to blue.
if (TagKey == HtmlTextWriterTag.Label)
{
    if (!IsAttributeDefined(HtmlTextWriterAttribute.Style))
    {
        AddAttribute("style", EncodeAttributeValue("color:blue", true));
        Write(NewLine);
        Indent = 3;
        OutputTabs();
    }
}

.NET Framework
Available since 1.1
Return to top
Show: