Export (0) Print
Expand All

Regex.Unescape Method

Converts any escaped characters in the input string.

Namespace:  System.Text.RegularExpressions
Assembly:  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.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.

Show:
© 2014 Microsoft