Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Regex.Escape Method

Escapes a minimal set of metacharacters (\, *, +, ?, |, {, [, (,), ^, $,., #, and white space) by replacing them with their escape codes.

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

public static string Escape (
	string str
)
public static String Escape (
	String str
)
public static function Escape (
	str : String
) : String
Not applicable.

Parameters

str

The input string containing the text to convert.

Return Value

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

Exception typeCondition

ArgumentNullException

str is a null reference (Nothing in Visual Basic).

Escape converts a string so it can be used as a constant within a regular expression. (The number sign (#) and white-space characters must be escaped so the string can be used within an expression parsed with the IgnorePatternWhitespace option enabled.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft