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
Not applicable.



The string to encode.


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 &amp;lt; and &amp;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 System.Web.HttpUtility.HtmlEncode method at run time from an ASP.NET application. Internally, HtmlEncode uses System.Web.HttpUtility.HtmlEncode to encode strings.

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 &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 Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions