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

HtmlEncode Method (String)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 11/.NET Framework 4.5

Other versions are also available for the following:

.NET Framework Class Library

WebUtility..::.HtmlEncode Method (String)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Converts a string to an HTML-encoded string.

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

Syntax

Visual Basic

Public Shared Function HtmlEncode ( _
	value As String _
) As String

public static string HtmlEncode(
	string value
)

Visual C++

public:
static String^ HtmlEncode(
	String^ value
)

static member HtmlEncode : 
        value:string -> string

Parameters

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

Return Value

Type: System..::.String
An encoded string.

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.

If the value parameter is nullNothingnullptra null reference (Nothing in Visual Basic), then the returned encoded string is nullNothingnullptra null reference (Nothing in Visual Basic). If the value parameter is an empty string, then the returned encoded string is an empty string.

Version Information

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Platforms

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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