SecurityElement.Escape Method (String)

 

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
)

Parameters

str
Type: System.String

The string within which to escape invalid characters.

Return Value

Type: System.String

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);

.NET Framework
Available since 1.1
Return to top
Show: