This documentation is archived and is not being maintained.

HttpServerUtility.UrlEncode Method (String, TextWriter)

URL-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 UrlEncode (
	string s,
	TextWriter output
public void UrlEncode (
	String s, 
	TextWriter output
public function UrlEncode (
	s : String, 
	output : TextWriter
Not applicable.



The text string to encode.


The TextWriter output stream that contains the encoded string.

URL encoding ensures that all browsers will correctly transmit text in URL strings. Characters such as a question mark (?), ampersand (&), slash mark (/), and spaces might be truncated or corrupted by some browsers. As a result, these characters must be encoded in <a> tags or in query strings where the strings can be re-sent by a browser in a request string.

UrlEncode is a convenient way to access the System.Web.HttpUtility.UrlEncode method at run time from an ASP.NET application. Internally, UrlEncode uses System.Web.HttpUtility.UrlEncode 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+%3cTest+String%3e.".

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

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

var testString : String = "This is a <Test String>."
var writer : StringWriter = new StringWriter()
Server.UrlEncode(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