SecurityElement.Escape(String) Method
In this article
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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);
public static string Escape(string str);
static member Escape : string -> string
Public Shared Function Escape (str As String) As String
- str
- String
The string within which to escape invalid characters.
The input string with invalid characters replaced.
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
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 |
---|---|
< |
< |
> |
> |
" |
" |
' |
' |
& |
& |
Applies to
Product | Versions |
---|---|
.NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 2.0, 2.1 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: