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)

public void HtmlEncode (
	string s,
	TextWriter output
public void HtmlEncode (
	String s, 
	TextWriter output
public function HtmlEncode (
	s : String, 
	output : TextWriter



The string to encode.


The TextWriter output stream containing 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 < or > characters, the browser would interpret these characters as part of HTML tags. The HTML encoding of these two characters is &lt and &gt, respectively, which causes the browser to display the angle brackets correctly.

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

The following code 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 &amp;lt;Test String&amp;gt;.".

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

String testString = "This is a <Test String>.";
StringWriter writer = new StringWriter();
get_Server().HtmlEncode(testString, writer);
String encodedString = writer.ToString();

var testString : String = "This is a <Test String>."
var writer : StringWriter = new StringWriter()
Server.HtmlEncode(testString, writer)
var encodedString : String = writer.ToString()

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0