0 out of 1 rated this helpful - Rate this topic

CompilationSection Class

Defines configuration settings that are used to support the compilation infrastructure of Web applications. This class cannot be inherited.

System.Object
  System.Configuration.ConfigurationElement
    System.Configuration.ConfigurationSection
      System.Web.Configuration.CompilationSection

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)
public sealed class CompilationSection : ConfigurationSection

The CompilationSection type exposes the following members.

  Name Description
Public method CompilationSection Infrastructure. Initializes a new instance of the CompilationSection class by using default settings.
Top
  Name Description
Public property Assemblies Gets the AssemblyCollection of the CompilationSection.
Public property AssemblyPostProcessorType Gets or sets a value specifying a post-process compilation step for an assembly.
Public property Batch Gets or sets a value indicating whether batch compilation is attempted.
Public property BatchTimeout Gets or sets the time-out period, in seconds, for batch compilation.
Public property BuildProviders Gets the BuildProviderCollection collection of the CompilationSection class.
Public property CodeSubDirectories Gets the CodeSubDirectoriesCollection of the CompilationSection.
Public property Compilers Gets the CompilerCollection collection of the CompilationSection class.
Public property CurrentConfiguration Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public property Debug Gets or sets a value specifying whether to compile release binaries or debug binaries.
Public property DefaultLanguage Gets or sets the default programming language to use in dynamic-compilation files.
Public property ElementInformation Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected property ElementProperty Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected property EvaluationContext Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Public property Explicit Gets or sets a value indicating whether to use the Microsoft Visual Basic explicit compile option.
Public property ExpressionBuilders Gets the ExpressionBuilderCollection of the CompilationSection.
Public property FolderLevelBuildProviders Gets the FolderLevelBuildProviderCollection collection of the CompilationSection class, which represents the build providers that are used during compilation.
Protected property Item[ConfigurationProperty] Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected property Item[String] Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public property LockAllAttributesExcept Gets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public property LockAllElementsExcept Gets the collection of locked elements. (Inherited from ConfigurationElement.)
Public property LockAttributes Gets the collection of locked attributes (Inherited from ConfigurationElement.)
Public property LockElements Gets the collection of locked elements. (Inherited from ConfigurationElement.)
Public property LockItem Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public property MaxBatchGeneratedFileSize Gets or sets the maximum combined size of the generated source files per batched compilation.
Public property MaxBatchSize Gets or sets the maximum number of pages per batched compilation.
Public property NumRecompilesBeforeAppRestart Gets or sets the number of dynamic recompiles of resources that can occur before the application restarts.
Public property OptimizeCompilations Gets or sets a value that indicates whether the compilation must be optimized.
Protected property Properties Gets the collection of properties. (Inherited from ConfigurationElement.)
Public property SectionInformation Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection.)
Public property Strict Gets or sets the Visual Basic strict compile option.
Public property TargetFramework Gets or sets the version of the .NET Framework that the Web site targets.
Public property TempDirectory Gets or sets a value that specifies the directory to use for temporary file storage during compilation.
Public property UrlLinePragmas Gets or sets a value indicating whether instructions to the compiler use physical paths or URLs.
Top
  Name Description
Protected method DeserializeElement Reads XML from the configuration file. (Inherited from ConfigurationElement.)
Protected method DeserializeSection Infrastructure. Reads XML from the configuration file. (Inherited from ConfigurationSection.)
Public method Equals Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Protected method GetRuntimeObject Returns a custom object when overridden in a derived class. (Inherited from ConfigurationSection.)
Protected method GetTransformedAssemblyString Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)
Protected method GetTransformedTypeString Returns the transformed version of the specified type name. (Inherited from ConfigurationElement.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Init Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected method InitializeDefault Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected method IsModified Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class. (Inherited from ConfigurationSection.)
Public method IsReadOnly Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected method ListErrors Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnDeserializeUnrecognizedAttribute Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected method OnDeserializeUnrecognizedElement Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected method OnRequiredPropertyNotFound Throws an exception when a required property is not found. (Inherited from ConfigurationElement.)
Protected method PostDeserialize Called after deserialization. (Inherited from ConfigurationElement.)
Protected method PreSerialize Called before serialization. (Inherited from ConfigurationElement.)
Protected method Reset Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected method ResetModified Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationSection.)
Protected method SerializeElement Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected method SerializeSection Infrastructure. Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file. (Inherited from ConfigurationSection.)
Protected method SerializeToXmlElement Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected method SetPropertyValue Sets a property to the specified value. (Inherited from ConfigurationElement.)
Protected method SetReadOnly Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Protected method ShouldSerializeElementInTargetVersion Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.)
Protected method ShouldSerializePropertyInTargetVersion Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.)
Protected method ShouldSerializeSectionInTargetVersion Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method Unmerge Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

The CompilationSection class provides a way to programmatically access and modify the content of the compilation section of the configuration file.

This example demonstrates how to specify values declaratively for several attributes of the compilation section, which can also be accessed as members of the CompilationSection class.

The following configuration file example shows how to specify values declaratively for the compilation section.

<system.web>
  <compilation 
    tempDirectory="" 
    debug="False" 
    strict="False" 
    explicit="True" 
    batch="True" 
    batchTimeout="900" 
    maxBatchSize="1000" 
    maxBatchGeneratedFileSize="1000" 
    numRecompilesBeforeAppRestart="15" 
    defaultLanguage="vb" 
    targetFramework="4.0" 
    urlLinePragmas="False" 
    assemblyPostProcessorType="">
    <assemblies>
      <clear />
    </assemblies>
    <buildProviders>
      <clear />
    </buildProviders>
    <expressionBuilders>
      <clear />
    </expressionBuilders>
  </compilation> 
</system.web>

The following code example demonstrates how to use members of the CompilationSection class.


#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingCompilationSection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        CompilationSection configSection =
          (CompilationSection)config.GetSection("system.web/compilation");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);

        // Display Assemblies collection count.
        Console.WriteLine("Assemblies Count: {0}",
          configSection.Assemblies.Count);

        // Display AssemblyPostProcessorType property.
        Console.WriteLine("AssemblyPostProcessorType: {0}", 
          configSection.AssemblyPostProcessorType);

        // Display Batch property.
        Console.WriteLine("Batch: {0}", configSection.Batch);

        // Set Batch property.
        configSection.Batch = true;

        // Display BatchTimeout property.
        Console.WriteLine("BatchTimeout: {0}",
          configSection.BatchTimeout);

        // Set BatchTimeout property.
        configSection.BatchTimeout = TimeSpan.FromMinutes(15);

          // Display BuildProviders collection count.
          Console.WriteLine("BuildProviders collection Count: {0}",
          configSection.BuildProviders.Count);

          // Display CodeSubDirectories collection count.
          Console.WriteLine("CodeSubDirectories Count: {0}",
        configSection.CodeSubDirectories.Count);

        // Display Compilers collection count.
        Console.WriteLine("Compilers Count: {0}",
        configSection.Compilers.Count);

        // Display Debug property.
        Console.WriteLine("Debug: {0}",
          configSection.Debug);

        // Set Debug property.
        configSection.Debug = false;

        // Display DefaultLanguage property.
        Console.WriteLine("DefaultLanguage: {0}",
          configSection.DefaultLanguage);

        // Set DefaultLanguage property.
        configSection.DefaultLanguage = "vb";

        // Display Explicit property.
        Console.WriteLine("Explicit: {0}",
          configSection.Explicit);

        // Set Explicit property.
        configSection.Explicit = true;

        // Display ExpressionBuilders collection count.
        Console.WriteLine("ExpressionBuilders Count: {0}",
          configSection.ExpressionBuilders.Count);

        // Display MaxBatchGeneratedFileSize property.
        Console.WriteLine("MaxBatchGeneratedFileSize: {0}", 
          configSection.MaxBatchGeneratedFileSize);

        // Set MaxBatchGeneratedFileSize property.
        configSection.MaxBatchGeneratedFileSize = 1000;

        // Display MaxBatchSize property.
        Console.WriteLine("MaxBatchSize: {0}", 
          configSection.MaxBatchSize);

        // Set MaxBatchSize property.
        configSection.MaxBatchSize = 1000;

        // Display NumRecompilesBeforeAppRestart property.
        Console.WriteLine("NumRecompilesBeforeAppRestart: {0}", 
          configSection.NumRecompilesBeforeAppRestart);

        // Set NumRecompilesBeforeAppRestart property.
        configSection.NumRecompilesBeforeAppRestart = 15;

        // Display Strict property.
        Console.WriteLine("Strict: {0}", 
          configSection.Strict);

        // Set Strict property.
        configSection.Strict = false;

        // Display TempDirectory property.
        Console.WriteLine("TempDirectory: {0}", configSection.TempDirectory);

        // Set TempDirectory property.
        configSection.TempDirectory = "myTempDirectory";

        // Display UrlLinePragmas property.
        Console.WriteLine("UrlLinePragmas: {0}", 
          configSection.UrlLinePragmas);

        // Set UrlLinePragmas property.
        configSection.UrlLinePragmas = false;

        // ExpressionBuilders Collection
        int i = 1;
        int j = 1;
        foreach (ExpressionBuilder expressionBuilder in configSection.ExpressionBuilders)
        {
          Console.WriteLine();
          Console.WriteLine("ExpressionBuilder {0} Details:", i);
          Console.WriteLine("Type: {0}", expressionBuilder.ElementInformation.Type);
          Console.WriteLine("Source: {0}", expressionBuilder.ElementInformation.Source);
          Console.WriteLine("LineNumber: {0}", expressionBuilder.ElementInformation.LineNumber);
          Console.WriteLine("Properties Count: {0}", expressionBuilder.ElementInformation.Properties.Count);
          j = 1;
          foreach (PropertyInformation propertyItem in expressionBuilder.ElementInformation.Properties)
          {
            Console.WriteLine("Property {0} Name: {1}", j, propertyItem.Name);
            Console.WriteLine("Property {0} Value: {1}", j, propertyItem.Value);
            j++;
          }
          i++;
        }

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ