This topic has not yet been rated - Rate this topic

SecurityElement.Escape Method

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

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

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, 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.

Did you find this helpful?
(1500 characters remaining)