WebUtility.HtmlEncode WebUtility.HtmlEncode WebUtility.HtmlEncode WebUtility.HtmlEncode Method

Definition

Converts a string to an HTML-encoded string.

Overloads

HtmlEncode(String) HtmlEncode(String) HtmlEncode(String) HtmlEncode(String)

Converts a string to an HTML-encoded string.

HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter)

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

HtmlEncode(String) HtmlEncode(String) HtmlEncode(String) HtmlEncode(String)

Converts a string to an HTML-encoded string.

public:
 static System::String ^ HtmlEncode(System::String ^ value);
public static string HtmlEncode (string value);
static member HtmlEncode : string -> string
Public Shared Function HtmlEncode (value As String) As String
Parameters
value
String String String String

The string to encode.

Returns

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 null, then the returned encoded string is null. If the value parameter is an empty string, then the returned encoded string is an empty string.

See Also

HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter) HtmlEncode(String, TextWriter)

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

public:
 static void HtmlEncode(System::String ^ value, System::IO::TextWriter ^ output);
public static void HtmlEncode (string value, System.IO.TextWriter output);
static member HtmlEncode : string * System.IO.TextWriter -> unit
Public Shared Sub HtmlEncode (value As String, output As TextWriter)
Parameters
value
String String String String

The string to encode.

Exceptions

The output parameter cannot be null if the value parameter is not null.

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.

See Also

Applies to