Export (0) Print
Expand All

GeneratorSupport Enumeration

Defines identifiers used to determine whether a code generator supports certain types of code elements.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:  System.CodeDom.Compiler
Assembly:  System (in System.dll)

[SerializableAttribute]
[FlagsAttribute]
public enum GeneratorSupport

Member nameDescription
ArraysOfArraysIndicates the generator supports arrays of arrays.
EntryPointMethodIndicates the generator supports a program entry point method designation. This is used when building executables.
GotoStatementsIndicates the generator supports goto statements.
MultidimensionalArraysIndicates the generator supports referencing multidimensional arrays. Currently, the CodeDom cannot be used to instantiate multidimensional arrays.
StaticConstructorsIndicates the generator supports static constructors.
TryCatchStatementsIndicates the generator supports try...catch statements.
ReturnTypeAttributesIndicates the generator supports return type attribute declarations.
DeclareValueTypesIndicates the generator supports value type declarations.
DeclareEnumsIndicates the generator supports enumeration declarations.
DeclareDelegatesIndicates the generator supports delegate declarations.
DeclareInterfacesIndicates the generator supports interface declarations.
DeclareEventsIndicates the generator supports event declarations.
AssemblyAttributesIndicates the generator supports assembly attributes.
ParameterAttributesIndicates the generator supports parameter attributes.
ReferenceParametersIndicates the generator supports reference and out parameters.
ChainedConstructorArgumentsIndicates the generator supports chained constructor arguments.
NestedTypesIndicates the generator supports the declaration of nested types.
MultipleInterfaceMembersIndicates the generator supports the declaration of members that implement multiple interfaces.
PublicStaticMembersIndicates the generator supports public static members.
ComplexExpressionsIndicates the generator supports complex expressions.
Win32ResourcesIndicates the generator supports compilation with Win32 resources.
ResourcesIndicates the generator supports compilation with .NET Framework resources. These can be default resources compiled directly into an assembly, or resources referenced in a satellite assembly.
PartialTypesIndicates the generator supports partial type declarations.
GenericTypeReferenceIndicates the generator supports generic type references.
GenericTypeDeclarationIndicates the generator supports generic type declarations.
DeclareIndexerPropertiesIndicates the generator supports the declaration of indexer properties.

These identifiers are used when calling the Supports method of a code generator to determine whether the code generator supports generating certain types of code.

The following example illustrates using CompilerParameters to specify various compiler settings and options.


public static bool CompileCode(CodeDomProvider provider, 
    String sourceFile, 
    String exeFile)
{

    CompilerParameters cp = new CompilerParameters();

    // Generate an executable instead of 
    // a class library.
    cp.GenerateExecutable = true;

    // Set the assembly file name to generate.
    cp.OutputAssembly = exeFile;

    // Generate debug information.
    cp.IncludeDebugInformation = true;

    // Add an assembly reference.
    cp.ReferencedAssemblies.Add( "System.dll" );

    // Save the assembly as a physical file.
    cp.GenerateInMemory = false;

    // Set the level at which the compiler 
    // should start displaying warnings.
    cp.WarningLevel = 3;

    // Set whether to treat all warnings as errors.
    cp.TreatWarningsAsErrors = false;

    // Set compiler argument to optimize output.
    cp.CompilerOptions = "/optimize";

    // Set a temporary files collection.
    // The TempFileCollection stores the temporary files
    // generated during a build in the current directory,
    // and does not delete them after compilation.
    cp.TempFiles = new TempFileCollection(".", true);

    if (provider.Supports(GeneratorSupport.EntryPointMethod))
    {
        // Specify the class that contains 
        // the main method of the executable.
        cp.MainClass = "Samples.Class1";
    }

    if (Directory.Exists("Resources"))
    {
        if (provider.Supports(GeneratorSupport.Resources))
        {
            // Set the embedded resource file of the assembly.
            // This is useful for culture-neutral resources,
            // or default (fallback) resources.
            cp.EmbeddedResources.Add("Resources\\Default.resources");

            // Set the linked resource reference files of the assembly.
            // These resources are included in separate assembly files,
            // typically localized for a specific language and culture.
            cp.LinkedResources.Add("Resources\\nb-no.resources");
        }
    }

    // Invoke compilation.
    CompilerResults cr = provider.CompileAssemblyFromFile(cp, sourceFile);

    if(cr.Errors.Count > 0)
    {
        // Display compilation errors.
        Console.WriteLine("Errors building {0} into {1}",  
            sourceFile, cr.PathToAssembly);
        foreach(CompilerError ce in cr.Errors)
        {
            Console.WriteLine("  {0}", ce.ToString());
            Console.WriteLine();
        }
    }
    else
    {
        Console.WriteLine("Source {0} built into {1} successfully.",
            sourceFile, cr.PathToAssembly);
        Console.WriteLine("{0} temporary files created during the compilation.",
            cp.TempFiles.Count.ToString());

    }

    // Return the results of compilation.
    if (cr.Errors.Count > 0)
    {
        return false;
    }
    else 
    {
        return true;
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft