WebUtility.HtmlEncode Method (String, TextWriter) (System.Net)

HtmlEncode Method (String, TextWrit...

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

WebUtility..::.HtmlEncode Method (String, TextWriter)

Converts a string into an HTML-encoded string, and returns the output as a TextWriter stream of output.

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

Syntax

Visual Basic

Public Shared Sub HtmlEncode ( _
    value As String, _
    output As TextWriter _
)

public static void HtmlEncode(
    string value,
    TextWriter output
)

Visual C++

public:
static void HtmlEncode(
    String^ value, 
    TextWriter^ output
)

static member HtmlEncode : 
        value:string * 
        output:TextWriter -> unit

Parameters

value: Type: System..::.String
The string to encode.

output: Type: System.IO..::.TextWriter
A TextWriter output stream.

Exceptions

Exception	Condition
ArgumentNullException	The output parameter cannot be nullNothingnullptra null reference (Nothing in Visual Basic) if the value parameter is not nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission.

Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

HttpUtility..::.HtmlDecode

System..::.Uri

Other Resources

How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings