HttpServerUtility.HtmlEncode Method (String, TextWriter)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public void HtmlEncode(
	string s,
	TextWriter output
)

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;.".

String TestString = "This is a <Test String>.";
StringWriter writer = new StringWriter();
Server.HtmlEncode(TestString, writer);
String EncodedString = writer.ToString();

.NET Framework
Available since 1.1
Return to top
Show: