Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Regex.Unescape Method

Converts any escaped characters in the input string.

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

public static string Unescape(
	string str
)

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.

ExceptionCondition
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.

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.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft