Regex.Unescape Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Converts any escaped characters in the input string.

Namespace:   System.Text.RegularExpressions
Assembly:  System (in System.dll)

static member Unescape : 
        str:string -> string

Parameters

str
Type: System.String

The input string containing the text to convert.

Return Value

Type: System.String

A string of characters with any escaped characters converted to their unescaped form.

Exception Condition
ArgumentException

str includes an unrecognized escape sequence.

ArgumentNullException

str is null.

The Unescape method performs one of the following two transformations:

  • It reverses the transformation performed by the Escape method by removing the escape character ("\") from each character escaped by the method. These include the \, *, +, ?, |, {, [, (,), ^, $,., #, and white space characters. In addition, the Unescape method unescapes the closing bracket (]) and closing brace (}) characters.

System_CAPS_noteNote

Unescape cannot reverse an escaped string perfectly because it cannot deduce precisely which characters were escaped,

  • It replaces the representation of unprintable characters with the characters themselves. For example, it replaces \a with \x07. The character representations it replaces are \a, \b, \e, \n, \r, \f, \t, and \v.

If the Unescape method encounters other escape sequences that it cannot convert, such as \w or \s, it throws an ArgumentException.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: