Export (0) Print
Expand All

BuildProviderCollection Class

Represents a collection of BuildProvider objects. This class cannot be inherited.

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

[ConfigurationCollectionAttribute(typeof(BuildProvider))]
public sealed class BuildProviderCollection : ConfigurationElementCollection

The BuildProviderCollection is used to compile custom resource files. You can have any number of build providers. The BuildProviderCollection does not refer to any actual element in the underlying configuration file. It is a construct that allows easy access to the compilation information it contains.

This section provides two code examples. The first demonstrates how to declaratively specify values for several properties of the BuildProviderCollection class. The second demonstrates how to use members of the BuildProviderCollection class.

The following configuration file example shows how to declaratively specify values for several properties of the BuildProviderCollection class.

<system.web>
  <compilation> 
    <buildProviders>
      <add extension=".aspx" 
        type="System.Web.Compilation.PageBuildProvider"
        appliesTo="Web" />
      <add extension=".ascx" 
        type="System.Web.Compilation.UserControlBuildProvider"
        appliesTo="Web" />
      <add extension=".master" 
        type="System.Web.Compilation.MasterPageBuildProvider"
        appliesTo="Web" />
      <add extension=".asix" 
        type="System.Web.Compilation.ImageGeneratorBuildProvider"
        appliesTo="Web" />
      <add extension=".asmx" 
        type="System.Web.Compilation.WebServiceBuildProvider"
        appliesTo="Web" />
      <add extension=".ashx" 
        type="System.Web.Compilation.WebHandlerBuildProvider"
        appliesTo="Web" />
      <add extension=".soap" 
        type="System.Web.Compilation.WebServiceBuildProvider"
        appliesTo="Web" />
      <add extension=".resx" 
        type="System.Web.Compilation.ResXBuildProvider"
        appliesTo="Resources" />
      <add extension=".resources" 
        type="System.Web.Compilation.ResourcesBuildProvider"
        appliesTo="Code, Resources" />
      <add extension=".wsdl" 
        type="System.Web.Compilation.WsdlBuildProvider"
        appliesTo="Code" />
      <add extension=".xsd" 
        type="System.Web.Compilation.XsdBuildProvider"
        appliesTo="Code" />
    </buildProviders>
  </compilation>
</system.web>

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

#region Using directives

using System;
using System.Configuration;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingBuildProviderCollection
  {
    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 BuildProviderCollection count.
        Console.WriteLine("BuildProviderCollection count: {0}",
          configSection.BuildProviders.Count);

        // Create a new BuildProvider.
        BuildProvider myBuildProvider =
          new BuildProvider(".myres",
          "System.Web.Compilation.ResourcesBuildProvider");

        // Add an BuildProvider to the collection.
        configSection.BuildProviders.Add(myBuildProvider);

        // Create a second BuildProvider.
        BuildProvider myBuildProvider2 =
          new BuildProvider(".myres2",
          "System.Web.Compilation.ResourcesBuildProvider");

        // Add an BuildProvider to the collection.
        configSection.BuildProviders.Add(myBuildProvider2);

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

        // Remove a BuildProvider.
        configSection.BuildProviders.Remove(".myres2");

        // Remove an BuildProvider.
        configSection.BuildProviders.RemoveAt(
          configSection.BuildProviders.Count - 1);

        // 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();
    }
  }
}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft