SecurityElement.Escape Method

Replaces invalid XML characters in a string with their valid XML equivalent.

Namespace: System.Security
Assembly: mscorlib (in mscorlib.dll)

public static string Escape (
	string str
)
public static String Escape (
	String str
)
public static function Escape (
	str : String
) : String

Parameters

str

The string within which to escape invalid characters.

Return Value

The input string with invalid characters replaced.

Use this method to replace invalid characters in a string before using the string in a SecurityElement. If invalid characters are used in a SecurityElement without being escaped, an ArgumentException is thrown.

The following table shows the invalid XML characters and their escaped equivalents.

invalid XML Character

Replaced With

"<"

"&lt;"

">"

"&gt;"

"\""

"&quot;"

"\'"

"&apos;"

"&"

"&amp;"

The following code shows the use of the Escape method to replace invalid XML characters in a string with their valid XML equivalent. This code example is part of a larger example provided for the SecurityElement class.

tagText = SecurityElement.Escape(tagText);

tagText = SecurityElement.Escape(tagText);

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

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show: