Home Library Learn Downloads Support Community
Sign in | United States - English | |
1 out of 1 rated this helpful - Rate this topic

SecurityElement.Escape Method

.NET Framework 3.5

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

Namespace:  System.Security
Assembly:  mscorlib (in mscorlib.dll)
C#
C++
JScript
VB
Copy 
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.

C#
C++
VB
Copy 
tagText = SecurityElement.Escape(tagText);

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
HTML doesn't support &apos; use &#39; instead
If you're planning to use the escaped string in HTML, you have to additionally replace the string &apos; with &#39; because the former is not officially supported in HTML.

http://blogs.msdn.com/kirillosenkov/archive/2010/03/19/apos-is-in-xml-in-html-use-39.aspx
History