Regex.CompileToAssembly Method (RegexCompilationInfo(), AssemblyName)


Compiles one or more specified Regex objects to a named assembly.

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

<HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort := True)>
Public Shared Sub CompileToAssembly (
	regexinfos As RegexCompilationInfo(),
	assemblyname As AssemblyName


Type: System.Text.RegularExpressions.RegexCompilationInfo()

An array that describes the regular expressions to compile.

Type: System.Reflection.AssemblyName

The file name of the assembly.

Exception Condition

The value of the assemblyname parameter's AssemblyName.Name property is an empty or null string.


The regular expression pattern of one or more objects in regexinfos contains invalid syntax.


assemblyname or regexinfos is null.

The CompileToAssembly(RegexCompilationInfo(), AssemblyName) method generates a .NET Framework assembly in which each regular expression defined in the regexinfos array is represented by a class. Typically, the CompileToAssembly(RegexCompilationInfo(), AssemblyName) method is called from a separate application that generates an assembly of compiled regular expressions. Each regular expression included in the assembly has the following characteristics:

  • It is derived from the Regex class.

  • It is assigned the fully qualified name that is defined by the fullnamespace and name parameters of its corresponding RegexCompilationInfo object.

  • It has a default (or parameterless) constructor.

Ordinarily, the code that instantiates and uses the compiled regular expression is found in an assembly or application that is separate from the code that creates the assembly.

Notes to Callers:

If you are developing on a system that has .NET Framework 4.5 or its point releases installed, you target .NET Framework 4, and you use the CompileToAssembly method to create an assembly that contains compiled regular expressions. Trying to use one of the regular expressions in that assembly on a system that has .NET Framework 4 throws an exception. To work around this problem, you can do either of the following:

  • Build the assembly that contains the compiled regular expressions on a system that has .NET Framework 4 instead of later versions installed.

  • Instead of calling CompileToAssembly and retrieving the compiled regular expression from an assembly, use either static or instance Regex methods with the RegexOptions.Compiled option when you instantiate a Regex object or call a regular expression pattern matching method.

The following example creates an assembly named RegexLib.dll. The assembly includes two compiled regular expressions. The first, Utilities.RegularExpressions.DuplicatedString, matches two identical contiguous words. The second, Utilities.RegularExpressions.EmailAddress, checks whether a string has the correct format to be an e-mail address.

Imports System.Collections.Generic
Imports System.Reflection
Imports System.Text.RegularExpressions

Module RegexCompilationTest
   Public Sub Main()
      Dim expr As RegexCompilationInfo
      Dim compilationList As New List(Of RegexCompilationInfo)

      ' Define regular expression to detect duplicate words
      expr = New RegexCompilationInfo("\b(?<word>\w+)\s+(\k<word>)\b", _
                 RegexOptions.IgnoreCase Or RegexOptions.CultureInvariant, _
                 "DuplicatedString", _
                 "Utilities.RegularExpressions", _
      ' Add info object to list of objects

      ' Define regular expression to validate format of email address
      expr = New RegexCompilationInfo("^(?("")(""[^""]+?""@)|(([0-9A-Z]((\.(?!\.))|[-!#\$%&'\*\+/=\?\^`\{\}\|~\w])*)(?<=[0-9A-Z])@))" + _
                 "(?(\[)(\[(\d{1,3}\.){3}\d{1,3}\])|(([0-9A-Z][-\w]*[0-9A-Z]\.)+[A-Z]{2,6}))$", _
                 RegexOptions.IgnoreCase Or RegexOptions.CultureInvariant, _
                 "EmailAddress", _
                 "Utilities.RegularExpressions", _
      ' Add info object to list of objects

      ' Generate assembly with compiled regular expressions
      Dim compilationArray(compilationList.Count - 1) As RegexCompilationInfo
      Dim assemName As New AssemblyName("RegexLib, Version=, Culture=neutral, PublicKeyToken=null")
      Regex.CompileToAssembly(compilationArray, assemName)                                                 
   End Sub
End Module

The regular expression that checks a string for duplicate words is then instantiated and used by the following example.

Imports Utilities.RegularExpressions

Module CompiledRegexUsage
   Public Sub Main()
      Dim text As String = "The the quick brown fox  fox jumped over the lazy dog dog."
      Dim duplicateRegex As New DuplicatedString()
      If duplicateRegex.Matches(text).Count > 0 Then
         Console.WriteLine("There are {0} duplicate words in {2}   '{1}'", _
            duplicateRegex.Matches(text).Count, text, vbCrLf)
         Console.WriteLine("There are no duplicate words in {1}   '{0}'", _
                           text, vbCrLf)
      End If
   End Sub
End Module
' The example displays the following output to the console:
'    There are 3 duplicate words in
'       'The the quick brown fox  fox jumped over the lazy dog dog.'

Successful compilation of this second example requires a reference to RegexLib.dll (the assembly created by the first example) to be added to the project.

.NET Framework
Available since 1.1
Return to top