BuildProviderCollection Class

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class BuildProviderCollection sealed : System::Configuration::ConfigurationElementCollection

[System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.BuildProvider))]
public sealed class BuildProviderCollection : System.Configuration.ConfigurationElementCollection

[<System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.BuildProvider))>]
type BuildProviderCollection = class
    inherit ConfigurationElementCollection

Public NotInheritable Class BuildProviderCollection
Inherits ConfigurationElementCollection

Inheritance: Object

ConfigurationElement

ConfigurationElementCollection
BuildProviderCollection

Attributes: ConfigurationCollectionAttribute

Examples

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"  
         />  
      <add extension=".ascx"   
        type="System.Web.Compilation.UserControlBuildProvider"  
         />  
      <add extension=".master"   
        type="System.Web.Compilation.MasterPageBuildProvider"  
         />  
      <add extension=".asix"   
        type="System.Web.Compilation.ImageGeneratorBuildProvider"  
         />  
      <add extension=".asmx"   
        type="System.Web.Compilation.WebServiceBuildProvider"  
         />  
      <add extension=".ashx"   
        type="System.Web.Compilation.WebHandlerBuildProvider"  
         />  
      <add extension=".soap"   
        type="System.Web.Compilation.WebServiceBuildProvider"  
         />  
      <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();
    }
  }
}

Imports System.Configuration
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingBuildProviderCollection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As _
         System.Web.Configuration.CompilationSection = _
         CType(config.GetSection("system.web/compilation"), _
         System.Web.Configuration.CompilationSection)

        ' 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.
        Dim myBuildProvider As BuildProvider = _
          New BuildProvider(".myres", _
          "System.Web.Compilation.ResourcesBuildProvider")

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

        ' Create a second BuildProvider.
        Dim myBuildProvider2 As BuildProvider = _
          New BuildProvider(".myres2", _
          "System.Web.Compilation.ResourcesBuildProvider")

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

        ' BuildProvider Collection
        Dim i = 1
        Dim j = 1
        For Each BuildProviderItem As _
          BuildProvider In configSection.BuildProviders
          Console.WriteLine()
          Console.WriteLine("BuildProvider {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
          For Each propertyItem As PropertyInformation In _
            BuildProviderItem.ElementInformation.Properties
            Console.WriteLine("Property {0} Name: {1}", j, _
              propertyItem.Name)
            Console.WriteLine("Property {0} Value: {1}", j, _
              propertyItem.Value)
            j = j + 1
          Next
          i = i + 1
        Next

        ' Remove an BuildProvider.
        configSection.BuildProviders.Remove(".myres2")

        ' Remove an BuildProvider.
        configSection.BuildProviders.RemoveAt( _
          configSection.BuildProviders.Count - 1)

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

Remarks

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.

Constructors

BuildProviderCollection()

Initializes a new instance of the BuildProviderCollection class.

Properties

AddElementName	Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ClearElementName	Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
CollectionType	Gets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
Count	Gets the number of elements in the collection. (Inherited from ConfigurationElementCollection)
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)
ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement)
ElementName	Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EmitClear	Gets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
IsSynchronized	Gets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection)
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[Int32]	Gets the BuildProvider object at the specified index of the collection.
Item[String]	Gets the BuildProvider collection element based on the specified name.
LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockAttributes	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement)
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)
RemoveElementName	Gets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SyncRoot	Gets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
ThrowOnDuplicate	Gets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown. (Inherited from ConfigurationElementCollection)

Methods

Add(BuildProvider)	Adds a BuildProvider object to the BuildProviderCollection.
BaseAdd(ConfigurationElement, Boolean)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseAdd(ConfigurationElement)	Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseClear()	Removes all configuration element objects from the collection. (Inherited from ConfigurationElementCollection)
BaseGet(Int32)	Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection)
BaseGet(Object)	Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection)
BaseGetAllKeys()	Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseGetKey(Int32)	Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Indicates the index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection)
BaseIsRemoved(Object)	Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseRemove(Object)	Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection)
BaseRemoveAt(Int32)	Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
Clear()	Clears all BuildProvider objects from the BuildProviderCollection.
CopyTo(ConfigurationElement[], Int32)	Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection)
CreateNewElement()	When overridden in a derived class, creates a new ConfigurationElement. (Inherited from ConfigurationElementCollection)
CreateNewElement(String)	Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
Equals(Object)	Compares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	Gets the element key for a specified configuration element when overridden in a derived class. (Inherited from ConfigurationElementCollection)
GetEnumerator()	Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
GetHashCode()	Gets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Init()	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement)
InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement)
IsElementName(String)	Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Indicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsModified()	Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection)
IsReadOnly()	Indicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Causes the configuration system to throw an exception. (Inherited from ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Remove(String)	Removes a BuildProvider object from the BuildProviderCollection.
RemoveAt(Int32)	Removes the BuildProvider object at the specified index from the BuildProviderCollection.
Reset(ConfigurationElement)	Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ResetModified()	Resets the value of the IsModified() property to `false` when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Reverses the effect of merging configuration information from different levels of the configuration hierarchy. (Inherited from ConfigurationElementCollection)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Dela via