/
Regular-Expression-Object.html
executable file
·30 lines (25 loc) · 19 KB
/
Regular-Expression-Object.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<?xml version="1.0" encoding="utf-8"?><html xmlns:xsl="urn:schemas-microsoft-com:xslt" xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp" xmlns:ms-help="http://msdn.microsoft.com/mshelp" xmlns:t="http://www.microsoft.com/topic/t" xmlns:msie="http://www.microsoft.com/ie/msie" xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:tool="http://www.microsoft.com/tooltip" xmlns:mso="urn:schemas-microsoft-com:office:office" xmlns:o="urn:schemas-microsoft-com:office:dvraddata" xmlns:u1="http://www.microsoft.com/vs/dvvwdcon" xmlns:anim="http://www.microsoft.com/windowssdk/anim" xmlns:w="http://www.microsoft.com/windows/w" xmlns:v="http://www.microsoft.com/windows/v" xmlns:msxsl="http://www.microsoft.com/aspnet/cpguide" xmlns:st1="http://www.microsoft.com/webservices/mscomwssdkproject" xmlns:ds="http://www.microsoft.com/xml/xmlsdk/ds" xmlns:xsd="http://www.microsoft.com/xml/xmlsdk/xsd" xmlns:xdr="http://www.microsoft.com/xml/xmlsdk/xdr" xmlns:sql="http://www.microsoft.com/sql/xmlsql" xmlns:ph="http://www.microsoft.com/ph/placeholder" xmlns:xlink="http://www.w3.org/1999/xlink"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="save" content="history" /><title>Regular Expression Object (JavaScript)</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="RegExp object, overview" /><meta name="System.Keywords" content="Regular Expression object" /><meta name="System.Keywords" content="regular expressions, RegExp object" /><meta name="Microsoft.Help.F1" content="RegularExpression_JavaScript" /><meta name="Microsoft.Help.Id" content="346aa83e-a045-47ea-acae-b42c7b121534" /><meta name="Description" content="An object that contains a regular expression pattern along with flags that identify how to apply the pattern." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="Refinement.TopicID" content="196" /><meta name="DCSext.ProductFamily" content="LIB_DG" /><meta name="DCSext.Product" content="VS_JScript" /><meta name="DCSext.Title" content="Regular Expression Object (JavaScript)" /><link rel="stylesheet" type="text/css" href="../styles/presentation.css" /><link rel="stylesheet" type="text/css" href="ms-help://Hx/HxRuntime/HxLink.css" /><script type="text/javascript" src="../scripts/EventUtilities.js"><![CDATA[ ]]></script><script type="text/javascript" src="../scripts/SplitScreen.js"><![CDATA[ ]]></script><script type="text/javascript" src="../scripts/Dropdown.js"><![CDATA[ ]]></script><script type="text/javascript" src="../scripts/script_manifold.js"><![CDATA[ ]]></script><script type="text/javascript" src="../scripts/script_feedBack.js"><![CDATA[ ]]></script><script type="text/javascript" src="../scripts/CheckboxMenu.js"><![CDATA[ ]]></script><script type="text/javascript" src="../scripts/CommonUtilities.js"><![CDATA[ ]]></script><xml><mshelp:toctitle title="Regular Expression Object" /><mshelp:keyword index="A" term="346aa83e-a045-47ea-acae-b42c7b121534" /><mshelp:keyword index="K" term="RegExp object, overview" /><mshelp:keyword index="K" term="Regular Expression object" /><mshelp:keyword index="K" term="regular expressions, RegExp object" /><mshelp:keyword index="F" term="RegularExpression_JavaScript" /><mshelp:attr name="RevisionNumber" value="11" /><mshelp:attr name="AssetID" value="346aa83e-a045-47ea-acae-b42c7b121534" /><mshelp:attr name="Abstract" value="An object that contains a regular expression pattern along with flags that identify how to apply the pattern." /><mshelp:attr name="TopicVersion" value="8.0.13105.10000" /><mshelp:attr name="Catalog Container" value="System_Default_Catalog" /><mshelp:attr name="Content Set Container" value="System_Default_Content_Set" /><mshelp:attr name="PreferredLib" value="/library/ie" /><mshelp:attr name="Search.Refinement.TopicID" value="196" /><mshelp:attr name="TopicType" value="kbSyntax" /><mshelp:attr name="Locale" value="en-us" /></xml></head><body><input type="hidden" id="userDataCache" class="userDataStyle" /><input type="hidden" id="hiddenScrollOffset" /><img id="collapseImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" alt="Collapse image" title="Collapse image" /><img id="expandImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" alt="Expand Image" title="Expand Image" /><img id="collapseAllImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" /><img id="expandAllImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" /><img id="dropDownImage" style="display:none; height:0; width:0;" src="../icons/dropdown.gif" /><img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="../icons/dropdownHover.gif" /><img id="copyImage" style="display:none; height:0; width:0;" src="../icons/copycode.gif" alt="Copy image" title="Copy image" /><img id="copyHoverImage" style="display:none; height:0; width:0;" src="../icons/copycodeHighlight.gif" alt="CopyHover image" title="CopyHover image" /><div id="header"><table id="topTable" cellspacing="0" cellpadding="0"><tr><td><span onclick="ExpandCollapseAll(toggleAllImage)" style="cursor:default;" onkeypress="ExpandCollapseAll_CheckKey(toggleAllImage, event)" tabindex="0"><img id="toggleAllImage" class="toggleAll" src="../icons/collapse_all.gif" /> <label id="collapseAllLabel" for="toggleAllImage" style="display: none;">Collapse All</label><label id="expandAllLabel" for="toggleAllImage" style="display: none;">Expand All</label> </span><span>    </span><span id="devlangsDropdown" class="filter" tabindex="0"><img id="devlangsDropdownImage" src="../icons/dropdown.gif" /> <label id="devlangsMenuAllLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: All </nobr></label><label id="devlangsMenuMultipleLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Multiple </nobr></label><label id="devlangsMenuVisualBasicLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual Basic </nobr></label><label id="devlangsMenuCSharpLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: C# </nobr></label><label id="devlangsMenuManagedCPlusPlusLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual C++ </nobr></label><label id="devlangsMenuFSharpLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: F# </nobr></label><label id="devlangsMenuHLSLLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: HLSL </nobr></label><label id="devlangsMenuJScriptLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: JScript </nobr></label></span></td></tr></table><div id="devlangsMenu"><input id="VisualBasicCheckbox" type="checkbox" data="VisualBasic,vb,'persist'" value="on" onclick="SetLanguage(this)" /><label class="checkboxLabel" for="VisualBasicCheckbox">Visual Basic</label><br /><input id="CSharpCheckbox" type="checkbox" data="CSharp,cs,'persist'" value="on" onclick="SetLanguage(this)" /><label class="checkboxLabel" for="CSharpCheckbox">C#</label><br /><input id="ManagedCPlusPlusCheckbox" type="checkbox" data="ManagedCPlusPlus,cpp,'persist'" value="on" onclick="SetLanguage(this)" /><label class="checkboxLabel" for="ManagedCPlusPlusCheckbox">Visual C++</label><br /><input id="FSharpCheckbox" type="checkbox" data="FSharp,fs,'persist'" value="on" onclick="SetLanguage(this)" /><label class="checkboxLabel" for="FSharpCheckbox">F#</label><br /><input id="HLSLCheckbox" type="checkbox" data="HLSL,cpp,'persist'" value="on" onclick="SetLanguage(this)" /><label class="checkboxLabel" for="HLSLCheckbox">HLSL</label><br /><input id="JScriptCheckbox" type="checkbox" data="JScript,cs,'persist'" value="on" onclick="SetLanguage(this)" /><label class="checkboxLabel" for="JScriptCheckbox">JScript</label><br /></div><table id="bottomTable" cellpadding="0" cellspacing="0"><tr id="headerTableRow1"><td align="left"><span id="runningHeaderText">JavaScript</span></td></tr><tr id="headerTableRow2"><td align="left"><span id="nsrTitle">Regular Expression Object (JavaScript)</span></td></tr><tr id="headerTableRow3"><td align="left"><a href="#exampleToggle" onclick="OpenSection(exampleToggle)">Example</a>  <a href="#seeAlsoToggle" onclick="OpenSection(seeAlsoToggle)">See Also</a> 
<span id="headfeedbackarea" class="feedbackhead">
<a href="javascript:SubmitFeedback('DevDocs@Microsoft.com','','','','8.0.13105.10000','%0\dThank%20you%20for%20your%20feedback.%20The%20developer%20writing%20teams%20use%20your%20feedback%20to%20improve%20documentation.%20While%20we%20are%20reviewing%20your%20feedback,%20we%20may%20send%20you%20e-mail%20to%20ask%20for%20clarification%20or%20feedback%20on%20a%20solution.%20We%20do%20not%20use%20your%20e-mail%20address%20for%20any%20other%20purpose%20and%20we%20delete%20it%20after%20we%20finish%20our%20review.%0\AFor%20further%20information%20about%20the%20privacy%20policies%20of%20Microsoft,%20please%20see%20http://privacy.microsoft.com/en-us/default.aspx.%0\A%0\d','Customer%20Feedback');">
Send Feedback
</a>
</span>
</td></tr></table><table id="gradientTable"><tr><td class="nsrBottom" background="../icons/gradient.gif" /></tr></table></div><div id="mainSection"><div id="mainBody"><div id="allHistory" class="saveHistory" onsave="saveAll()" onload="loadAll()" /><font color="DarkGray"><p /></font> <div class="introduction"><p xmlns:util="util">An object that contains a regular expression pattern along with flags that identify how to apply the pattern.</p></div><div id="syntaxSection" class="section"><div id="syntaxCodeBlocks" class="code"><span codelanguage="other"><table width="100%" cellspacing="0" cellpadding="0"><tr><th align="left" /></tr><tr><td><pre>re = <b xmlns:util="util">/</b><span class="parameter" sdata="paramReference" xmlns:util="util">pattern</span><b xmlns:util="util">/</b>[<span class="parameter" sdata="paramReference" xmlns:util="util">flags</span>]</pre></td></tr></table></span></div></div><div id="syntaxSection" class="section"><div id="syntaxCodeBlocks" class="code"><span codelanguage="other"><table width="100%" cellspacing="0" cellpadding="0"><tr><th align="left" /></tr><tr><td><pre>re = <b xmlns:util="util">new RegExp("</b><span class="parameter" sdata="paramReference" xmlns:util="util">pattern</span><b xmlns:util="util">"</b>[<b xmlns:util="util">,"</b><span class="parameter" sdata="paramReference" xmlns:util="util">flags</span><b xmlns:util="util">"</b>]<b xmlns:util="util">)</b> </pre></td></tr></table></span></div></div><h1 class="heading"><span onclick="ExpandCollapse(sectionToggle0)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(sectionToggle0, event)" tabindex="0"><img id="sectionToggle0" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Parameters</span></h1><div id="sectionSection0" class="section" name="collapseableSection" style="" expanded="true"><dl class="authored"><dt><i xmlns:util="util">re</i></dt><dd><p xmlns:util="util">Required. The variable name to which the regular expression pattern is assigned.</p></dd><dt><i xmlns:util="util">pattern</i></dt><dd><p xmlns:util="util">Required. The regular expression pattern to use. If you use Syntax 1, delimit the pattern by "/" characters. If you use Syntax 2, enclose the pattern in quotation marks.</p></dd><dt><span class="parameter" sdata="paramReference" xmlns:util="util">flags</span></dt><dd><p xmlns:util="util">Optional. Enclose flag in quotation marks if you use Syntax 2. Available flags, which may be combined, are:</p><ul xmlns:util="util"><li><p>g (global search for all occurrences of <i>pattern</i>)</p></li><li><p>i (ignore case)</p></li><li><p>m (multiline search)</p></li></ul></dd></dl></div><h1 class="heading"><span onclick="ExpandCollapse(languageReferenceRemarksToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(languageReferenceRemarksToggle, event)" tabindex="0"><img id="languageReferenceRemarksToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Remarks</span></h1><div id="languageReferenceRemarksSection" class="section" name="collapseableSection" style=""><p xmlns:util="util">The <b>Regular Expression</b> object should not be confused with the global <b>RegExp</b> object. Even though they sound the same, they are separate and distinct. The properties of the <b>Regular Expression</b> object contain only information about one particular <b>Regular Expression</b> instance, while the properties of the global <b>RegExp</b> object contain continually updated information about each match as it occurs.</p><p xmlns:util="util"><b>Regular Expression</b> objects store patterns used when searching strings for character combinations. After the <b>Regular Expression</b> object is created, it is either passed to a string method, or a string is passed to one of the regular expression methods. Information about the most recent search performed is stored in the global <b>RegExp</b> object.</p><p xmlns:util="util">Use Syntax 1 when you know the search string ahead of time. Use Syntax 2 when the search string is changing frequently, or is unknown, such as strings taken from user input.</p><p xmlns:util="util">The <i>pattern</i> argument is compiled into an internal format before use. For Syntax 1, <i>pattern</i> is compiled as the script is loaded. For Syntax 2, <i>pattern</i> is compiled just before use, or when the <b>compile</b> method is called. </p></div><h1 class="heading"><span onclick="ExpandCollapse(exampleToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(exampleToggle, event)" tabindex="0"><img id="exampleToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Example</span></h1><div id="exampleSection" class="section" name="collapseableSection" style=""><p xmlns:util="util">The following example illustrates the use of the <b>Regular Expression</b> object by creating an object (re) containing a regular expression pattern with its associated flags. In this case, the resulting <b>Regular Expression</b> object is then used by the <b>match</b> method:</p><div class="code"><span codelanguage="JavaScript"><table width="100%" cellspacing="0" cellpadding="0"><tr><th>JavaScript </th><th><span class="copyCode" onclick="CopyCode(this)" onkeypress="CopyCode_CheckKey(this, event)" onmouseover="ChangeCopyCodeIcon(this)" onmouseout="ChangeCopyCodeIcon(this)" tabindex="0"><img class="copyCodeImage" name="ccImage" align="absmiddle" alt="Copy image" title="Copy image" src="../icons/copycode.gif" />Copy Code</span></th></tr><tr><td colspan="2"><pre>function MatchDemo(){
var s = "through the pages of the book";
// Create regular expression pattern.
var re = new RegExp("the", "i");
// Attempt match on search string.
var r = s.match(re);
// Return first occurrence of "the".
return(r);
}</pre></td></tr></table></span></div></div><a name="js56jsobjregexpressionprop" xmlns:util="util" /><h1 class="heading"><span onclick="ExpandCollapse(sectionToggle1)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(sectionToggle1, event)" tabindex="0"><img id="sectionToggle1" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Properties</span></h1><div id="sectionSection1" class="section" name="collapseableSection" style="" expanded="true"><p xmlns:util="util"><mshelp:link keywords="76A0F115-0D89-4ACA-86D5-932895C6D649" tabindex="0">global Property</mshelp:link> | <mshelp:link keywords="816F0DF5-5A82-44A5-A4AB-DBC91FA76E61" tabindex="0">ignoreCase Property</mshelp:link> | <mshelp:link keywords="CA7B276A-1FE2-4189-AC27-F089AB3E9974" tabindex="0">multiline Property</mshelp:link> | <mshelp:link keywords="D58AC57E-FCDE-49D1-BBBA-E8C4218448C4" tabindex="0">source Property</mshelp:link></p></div><a name="js56jsobjregexpressionmeth" xmlns:util="util" /><h1 class="heading"><span onclick="ExpandCollapse(sectionToggle2)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(sectionToggle2, event)" tabindex="0"><img id="sectionToggle2" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Methods</span></h1><div id="sectionSection2" class="section" name="collapseableSection" style="" expanded="true"><p xmlns:util="util"><mshelp:link keywords="DC28CAE3-478D-49B5-B5EA-203E5EDFE195" tabindex="0">compile Method</mshelp:link> | <mshelp:link keywords="83092452-60CC-4218-B4AE-AF9E3CB96C34" tabindex="0">exec Method</mshelp:link> | <mshelp:link keywords="4F4B6E39-CB1A-4BE9-A66F-7B846075580D" tabindex="0">test Method</mshelp:link></p></div><h1 class="heading"><span onclick="ExpandCollapse(requirementsTitleToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(requirementsTitleToggle, event)" tabindex="0"><img id="requirementsTitleToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Requirements</span></h1><div id="requirementsTitleSection" class="section" name="collapseableSection" style=""><p xmlns:util="util">
</p><p>Supported in the following document modes: Quirks, Internet Explorer 6 standards, Internet Explorer 7 standards, Internet Explorer 8 standards, Internet Explorer 9 standards, Internet Explorer 10 standards. Also supported in Windows Store apps. See <mshelp:link keywords="440f4924-f7a9-48e0-873e-bd599a93b437" tabindex="0">Version Information</mshelp:link>. </p>
</div><h1 class="heading"><span onclick="ExpandCollapse(seeAlsoToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(seeAlsoToggle, event)" tabindex="0"><img id="seeAlsoToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />See Also</span></h1><div id="seeAlsoSection" class="section" name="collapseableSection" style=""><h4 class="subHeading">Other Resources</h4><div class="seeAlsoStyle"><span sdata="link" xmlns:util="util"><a href="7f6b1073-8cbb-49ed-94b6-56833ba663c5.htm">RegExp Object (JavaScript)</a></span></div><div class="seeAlsoStyle"><span sdata="link" xmlns:util="util"><mshelp:link keywords="ab0766e1-7037-45ed-aa23-706f58358c0e" tabindex="0">Regular Expression Syntax</mshelp:link></span></div><div class="seeAlsoStyle"><span sdata="link" xmlns:util="util"><a href="8063ecd5-5778-4e87-b985-b21420171914.htm">String Object (JavaScript)</a></span></div></div></div><div id="footer"><div class="footerLine"><img width="100%" height="3px" src="../icons/footer.gif" alt="Footer image" title="Footer image" /></div>
<span id="feedbackarea">
Send
<a href="javascript:SubmitFeedback('DevDocs@Microsoft.com','','','','8.0.13105.10000','%0\dThank%20you%20for%20your%20feedback.%20The%20developer%20writing%20teams%20use%20your%20feedback%20to%20improve%20documentation.%20While%20we%20are%20reviewing%20your%20feedback,%20we%20may%20send%20you%20e-mail%20to%20ask%20for%20clarification%20or%20feedback%20on%20a%20solution.%20We%20do%20not%20use%20your%20e-mail%20address%20for%20any%20other%20purpose%20and%20we%20delete%20it%20after%20we%20finish%20our%20review.%0\AFor%20further%20information%20about%20the%20privacy%20policies%20of%20Microsoft,%20please%20see%20http://privacy.microsoft.com/en-us/default.aspx.%0\A%0\d','Customer%20Feedback');">
feedback
</a>
on this topic to Microsoft.
</span>
</div></div></body></html>