Export (0) Print
Expand All

HttpServerUtility.HtmlEncode Method (String, TextWriter)

HTML-encodes a string and sends the resulting output to a TextWriter output stream.

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

member HtmlEncode : 
        s:string * 
        output:TextWriter -> unit

Parameters

s
Type: System.String

The string to encode.

output
Type: System.IO.TextWriter

The TextWriter output stream that contains the encoded string.

HTML encoding ensures that text will be correctly displayed in the browser, not interpreted by the browser as HTML. For example, if a text string contains a less than sign (<) or greater than sign (>), the browser would interpret these characters as an opening or closing bracket of an HTML tag. The HTML encoding of these two characters is &lt; and &gt;, respectively, which causes the browser to display the less than sign and greater than sign correctly.

HtmlEncode is a convenient way to access the HttpUtility.HtmlEncode method at run time from an ASP.NET application. Internally, HtmlEncode uses HttpUtility.HtmlEncode to encode strings.

To encode or decode values outside of a web application, use the WebUtility class.

The following example encodes a string for transmission by HTTP. It encodes the string named TestString, which contains the text "This is a <Test String>.", and copies it into the string named EncodedString as "This is a &lt;Test String&gt;.".

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft