SecurityElement.Escape(String) Method

Definition

Namespace:

System.Security

Assembly:

System.Runtime.dll

Source:

SecurityElement.cs

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

public:
 static System::String ^ Escape(System::String ^ str);

public static string? Escape (string? str);

static member Escape : string -> string

Public Shared Function Escape (str As String) As String

Parameters

str

String

The string within which to escape invalid characters.

Returns

String

The input string with invalid characters replaced.

Examples

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

    tagText = SecurityElement.Escape(tagText)
End If

Remarks

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;