RegExpConstructor.xml

<Type Name="RegExpConstructor" FullName="Microsoft.JScript.RegExpConstructor">
  <TypeSignature Language="C#" Value="public sealed class RegExpConstructor : Microsoft.JScript.ScriptFunction" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RegExpConstructor extends Microsoft.JScript.ScriptFunction" />
  <TypeSignature Language="DocId" Value="T:Microsoft.JScript.RegExpConstructor" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class RegExpConstructor&#xA;Inherits ScriptFunction" />
  <TypeSignature Language="F#" Value="type RegExpConstructor = class&#xA;    inherit ScriptFunction" />
  <TypeSignature Language="C++ CLI" Value="public ref class RegExpConstructor sealed : Microsoft::JScript::ScriptFunction" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.JScript</AssemblyName>
    <AssemblyVersion>7.0.5000.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.JScript.ScriptFunction</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents a prototype-based object that is defined by a constructor function. This class belongs to the built-in object model category.</summary>
    <remarks>To be added.</remarks>
    <forInternalUseOnly />
    <altmember cref="T:Microsoft.JScript.RegExpObject" />
    <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
  </Docs>
  <Members>
    <Member MemberName="Construct">
      <MemberSignature Language="C#" Value="public object Construct (string pattern, bool ignoreCase, bool global, bool multiline);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance object Construct(string pattern, bool ignoreCase, bool global, bool multiline) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.RegExpConstructor.Construct(System.String,System.Boolean,System.Boolean,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Public Function Construct (pattern As String, ignoreCase As Boolean, global As Boolean, multiline As Boolean) As Object" />
      <MemberSignature Language="F#" Value="override this.Construct : string * bool * bool * bool -&gt; obj" Usage="regExpConstructor.Construct (pattern, ignoreCase, global, multiline)" FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Object ^ Construct(System::String ^ pattern, bool ignoreCase, bool global, bool multiline);" />
      <MemberSignature Language="F#" Value="member this.Construct : string * bool * bool * bool -&gt; obj" Usage="regExpConstructor.Construct (pattern, ignoreCase, global, multiline)" FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="pattern" Type="System.String" />
        <Parameter Name="ignoreCase" Type="System.Boolean" />
        <Parameter Name="global" Type="System.Boolean" />
        <Parameter Name="multiline" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="pattern">The regular expression pattern to match.</param>
        <param name="ignoreCase">
          <see langword="true" /> to use case-insensitive matching; otherwise, <see langword="false" />.</param>
        <param name="global">
          <see langword="true" /> to use a global match; otherwise, <see langword="false" />.</param>
        <param name="multiline">
          <see langword="true" /> to use a multiline match; otherwise, <see langword="false" />.</param>
        <summary>Creates a new <see cref="T:Microsoft.JScript.RegExpObject" /> object for the specified regular expression pattern and flags.</summary>
        <returns>A new <see cref="T:Microsoft.JScript.RegExpObject" /> object.</returns>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="CreateInstance">
      <MemberSignature Language="C#" Value="public Microsoft.JScript.RegExpObject CreateInstance (params object[] args);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.JScript.RegExpObject CreateInstance(object[] args) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.RegExpConstructor.CreateInstance(System.Object[])" />
      <MemberSignature Language="VB.NET" Value="Public Function CreateInstance (ParamArray args As Object()) As RegExpObject" />
      <MemberSignature Language="F#" Value="override this.CreateInstance : obj[] -&gt; Microsoft.JScript.RegExpObject" Usage="regExpConstructor.CreateInstance args" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; Microsoft::JScript::RegExpObject ^ CreateInstance(... cli::array &lt;System::Object ^&gt; ^ args);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Microsoft.JScript.JSFunction(Microsoft.JScript.JSFunctionAttributeEnum.HasVarArgs)]</AttributeName>
          <AttributeName Language="F#">[&lt;Microsoft.JScript.JSFunction(Microsoft.JScript.JSFunctionAttributeEnum.HasVarArgs)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.JScript.RegExpObject</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="args" Type="System.Object[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="args">The arguments to pass to the constructor.</param>
        <summary>Creates an instance of the prototype-based object, passing in the specified arguments.</summary>
        <returns>An instance of the object.</returns>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="index">
      <MemberSignature Language="C#" Value="public object index { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object index" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.RegExpConstructor.index" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property index As Object" />
      <MemberSignature Language="F#" Value="member this.index : obj" Usage="Microsoft.JScript.RegExpConstructor.index" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ index { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the index of the last successful match, before advancing the index.</summary>
        <value>The index of the last successful match, if there was one.</value>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="input">
      <MemberSignature Language="C#" Value="public object input { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object input" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.RegExpConstructor.input" />
      <MemberSignature Language="VB.NET" Value="Public Property input As Object" />
      <MemberSignature Language="F#" Value="member this.input : obj with get, set" Usage="Microsoft.JScript.RegExpConstructor.input" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ input { System::Object ^ get(); void set(System::Object ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the input string for a regular expression search.</summary>
        <value>The input string for a regular expression search.</value>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="Invoke">
      <MemberSignature Language="C#" Value="public Microsoft.JScript.RegExpObject Invoke (params object[] args);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.JScript.RegExpObject Invoke(object[] args) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.RegExpConstructor.Invoke(System.Object[])" />
      <MemberSignature Language="VB.NET" Value="Public Function Invoke (ParamArray args As Object()) As RegExpObject" />
      <MemberSignature Language="F#" Value="override this.Invoke : obj[] -&gt; Microsoft.JScript.RegExpObject" Usage="regExpConstructor.Invoke args" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; Microsoft::JScript::RegExpObject ^ Invoke(... cli::array &lt;System::Object ^&gt; ^ args);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Microsoft.JScript.JSFunction(Microsoft.JScript.JSFunctionAttributeEnum.HasVarArgs)]</AttributeName>
          <AttributeName Language="F#">[&lt;Microsoft.JScript.JSFunction(Microsoft.JScript.JSFunctionAttributeEnum.HasVarArgs)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.JScript.RegExpObject</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="args" Type="System.Object[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="args">The arguments to pass to the constructor.</param>
        <summary>Creates an instance of a prototype-based object, passing in the specified arguments.</summary>
        <returns>An instance of the object.</returns>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="lastIndex">
      <MemberSignature Language="C#" Value="public object lastIndex { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object lastIndex" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.RegExpConstructor.lastIndex" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property lastIndex As Object" />
      <MemberSignature Language="F#" Value="member this.lastIndex : obj" Usage="Microsoft.JScript.RegExpConstructor.lastIndex" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ lastIndex { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the index of the last successful match, after advancing the index.</summary>
        <value>The index of the last successful match, if there was one.</value>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="lastMatch">
      <MemberSignature Language="C#" Value="public object lastMatch { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object lastMatch" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.RegExpConstructor.lastMatch" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property lastMatch As Object" />
      <MemberSignature Language="F#" Value="member this.lastMatch : obj" Usage="Microsoft.JScript.RegExpConstructor.lastMatch" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ lastMatch { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a string representation of the last successful match.</summary>
        <value>A string representation of the last successful match, if there was one.</value>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="lastParen">
      <MemberSignature Language="C#" Value="public object lastParen { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object lastParen" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.RegExpConstructor.lastParen" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property lastParen As Object" />
      <MemberSignature Language="F#" Value="member this.lastParen : obj" Usage="Microsoft.JScript.RegExpConstructor.lastParen" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ lastParen { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the last <see cref="T:System.Text.RegularExpressions.Group" /> from the <see cref="P:System.Text.RegularExpressions.Match.Groups" /> of the last match.</summary>
        <value>A string representation of the last group, if there was one.</value>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="leftContext">
      <MemberSignature Language="C#" Value="public object leftContext { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object leftContext" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.RegExpConstructor.leftContext" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property leftContext As Object" />
      <MemberSignature Language="F#" Value="member this.leftContext : obj" Usage="Microsoft.JScript.RegExpConstructor.leftContext" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ leftContext { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a substring of the input string between the start of the input and the start of the last successful match.</summary>
        <value>A substring of the input string, if there was one.</value>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
    <Member MemberName="rightContext">
      <MemberSignature Language="C#" Value="public object rightContext { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object rightContext" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.RegExpConstructor.rightContext" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property rightContext As Object" />
      <MemberSignature Language="F#" Value="member this.rightContext : obj" Usage="Microsoft.JScript.RegExpConstructor.rightContext" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ rightContext { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>7.0.5000.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a substring of the input string between the start of the last successful match and the end of the input.</summary>
        <value>A substring of the input string, if there was one.</value>
        <remarks>To be added.</remarks>
        <forInternalUseOnly />
        <altmember cref="T:Microsoft.JScript.RegExpObject" />
        <altmember cref="T:Microsoft.JScript.RegExpPrototype" />
      </Docs>
    </Member>
  </Members>
</Type>