ControlBuilder.HtmlDecodeLiterals Method

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

Determines whether the literal string of an HTML control must be HTML decoded. This method is called by the ASP.NET page framework.

public:
 virtual bool HtmlDecodeLiterals();

public virtual bool HtmlDecodeLiterals ();

abstract member HtmlDecodeLiterals : unit -> bool
override this.HtmlDecodeLiterals : unit -> bool

Public Overridable Function HtmlDecodeLiterals () As Boolean

Returns

Boolean

true if the HTML control literal string is to be decoded; otherwise, false.

Examples

The following example overrides the HtmlDecodeLiterals method to allow HTML decoding of literal strings in any control this builder is applied to.

// Override the HtmlDecodeLiterals method to allow HTML
// decoding of literal strings in any controls this builder
// is applied to.
public override bool HtmlDecodeLiterals()
{
    return true;
}

' Override the HtmlDecodeLiterals method to allow HTML
' decoding of literal strings in any controls this builder
' is applied to.
Public Overrides Function HtmlDecodeLiterals() As Boolean
    Return True
End Function

Remarks

A literal string refers to the text between the opening and closing tag of an HTML control. HTML encoding is when text is converted into a string representation that the browser will display rather than interpret as HTML. Characters such as the question mark (?), ampersand (&), slash mark (/), and spaces might be truncated or corrupted by some browsers, so those characters must be encoded when they appear in a tags or in query strings.

The HtmlDecodeLiterals method is called by the ASP.NET page framework during parsing and is not intended to be called directly in you code.