BuildProvider.CodeCompilerType Property

 

Represents the compiler type used by a build provider to generate source code for a custom file type.

Namespace:   System.Web.Compilation
Assembly:  System.Web (in System.Web.dll)

Public Overridable ReadOnly Property CodeCompilerType As CompilerType

Property Value

Type: System.Web.Compilation.CompilerType

A read-only System.Web.Compilation.CompilerType representing the code generator, code compiler, and compiler settings used to build source code for the virtual path. The base class returns null.

Use the CodeCompilerType property to provide the settings for compiling source code for an implementation of BuildProvider. The CodeCompilerType property is null if the build provider does not require a specific code language for generating and compiling source code.

To set the value for a CompilerType object within a build provider implementation, use the GetDefaultCompilerType or GetDefaultCompilerTypeForLanguage method.

The CodeDomProviderType property specifies the CodeDomProvider implementation that is used to generate and compile source code for a build provider. The CompilerParameters property defines the settings that are used to compile the source code into an assembly.

The following code example illustrates a simple build provider implementation, inheriting from the abstract BuildProvider base class. The build provider overrides the CodeCompilerType, GetGeneratedType, and GenerateCode members of the base class.

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections
Imports System.IO
Imports System.Text
Imports System.Web
Imports System.Web.Compilation
Imports System.CodeDom.Compiler
Imports System.CodeDom
Imports System.Security
Imports System.Security.Permissions

<PermissionSet(SecurityAction.Demand, Unrestricted := true)> _
Public Class SampleBuildProvider
    Inherits BuildProvider

    Protected _compilerType As CompilerType = Nothing

    Public Sub New()
        _compilerType = GetDefaultCompilerType()
    End Sub

    ' Return the internal CompilerType member 
    ' defined in this implementation.
    Public Overrides ReadOnly Property CodeCompilerType() As CompilerType
        Get
            CodeCompilerType = _compilerType
        End Get
    End Property


    ' Define the build provider implementation of the GenerateCode method.
    Public Overrides Sub GenerateCode(ByVal assemBuilder As AssemblyBuilder)
        ' Generate a code compile unit, and add it to
        ' the assembly builder.

        Dim tw As TextWriter = assemBuilder.CreateCodeFile(Me)
        If Not tw Is Nothing Then
            Try
                ' Generate the code compile unit from the virtual path.
                Dim compileUnit As CodeCompileUnit = _
                        SampleClassGenerator.BuildCompileUnitFromPath(VirtualPath)

                ' Generate the source for the code compile unit, 
                ' and write it to a file specified by the assembly builder.
                Dim provider As CodeDomProvider = assemBuilder.CodeDomProvider
                provider.GenerateCodeFromCompileUnit(compileUnit, tw, Nothing)
            Finally
                tw.Close()
            End Try

        End If
    End Sub

    Public Overrides Function GetGeneratedType(ByVal results As CompilerResults) As System.Type
        Dim typeName As String = SampleClassGenerator.TypeName

        Return results.CompiledAssembly.GetType(typeName)
    End Function

End Class

.NET Framework
Available since 2.0
Return to top
Show: