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)

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 makes sure that text is displayed correctly in the browser and 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 the opening or closing bracket of an HTML tag. When the characters are HTML encoded, they are converted to the strings &lt; and &gt;, 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.

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();

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft