Export (0) Print
Expand All

ConfigurationElementCollection Class

Represents a configuration element containing a collection of child elements.

System.Object
  System.Configuration.ConfigurationElement
    System.Configuration.ConfigurationElementCollection
      More...

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

public abstract class ConfigurationElementCollection : ConfigurationElement, 
	ICollection, IEnumerable

The ConfigurationElementCollection type exposes the following members.

  NameDescription
Protected methodConfigurationElementCollection()Initializes a new instance of the ConfigurationElementCollection class.
Protected methodConfigurationElementCollection(IComparer)Creates a new instance of the ConfigurationElementCollection class.
Top

  NameDescription
Protected propertyAddElementNameGets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class.
Protected propertyClearElementNameGets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class.
Public propertyCollectionTypeGets the type of the ConfigurationElementCollection.
Public propertyCountGets the number of elements in the collection.
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementNameGets the name used to identify this collection of elements in the configuration file when overridden in a derived class.
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Public propertyEmitClearGets or sets a value that specifies whether the collection has been cleared.
Protected propertyEvaluationContextGets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe).
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Protected propertyRemoveElementNameGets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class.
Public propertySyncRootGets an object used to synchronize access to the ConfigurationElementCollection.
Protected propertyThrowOnDuplicateGets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown.
Top

  NameDescription
Protected methodBaseAdd(ConfigurationElement)Adds a configuration element to the ConfigurationElementCollection.
Protected methodBaseAdd(ConfigurationElement, Boolean)Adds a configuration element to the configuration element collection.
Protected methodBaseAdd(Int32, ConfigurationElement)Adds a configuration element to the configuration element collection.
Protected methodBaseClearRemoves all configuration element objects from the collection.
Protected methodBaseGet(Int32)Gets the configuration element at the specified index location.
Protected methodBaseGet(Object)Returns the configuration element with the specified key.
Protected methodBaseGetAllKeysReturns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection.
Protected methodBaseGetKeyGets the key for the ConfigurationElement at the specified index location.
Protected methodBaseIndexOfThe index of the specified ConfigurationElement.
Protected methodBaseIsRemovedGets a value indicating whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection.
Protected methodBaseRemoveRemoves a ConfigurationElement from the collection.
Protected methodBaseRemoveAtRemoves the ConfigurationElement at the specified index location.
Public methodCopyToCopies the contents of the ConfigurationElementCollection to an array.
Protected methodCreateNewElement()When overridden in a derived class, creates a new ConfigurationElement.
Protected methodCreateNewElement(String)Creates a new ConfigurationElement when overridden in a derived class.
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the ConfigurationElementCollection to the specified object. (Overrides ConfigurationElement.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetElementKeyGets the element key for a specified configuration element when overridden in a derived class.
Public methodGetEnumeratorInfrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection.
Public methodGetHashCodeGets a unique value representing the ConfigurationElementCollection instance. (Overrides ConfigurationElement.GetHashCode().)
Protected methodGetTransformedAssemblyStringReturns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)
Protected methodGetTransformedTypeStringReturns the transformed version of the specified type name. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsElementNameIndicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection.
Protected methodIsElementRemovableGets a value indicating whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection.
Protected methodIsModifiedIndicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Overrides ConfigurationElement.IsModified().)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElementCollection object is read only. (Overrides ConfigurationElement.IsReadOnly().)
Protected methodListErrorsAdds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDeserializeUnrecognizedAttributeGets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected methodOnDeserializeUnrecognizedElementCauses the configuration system to throw an exception. (Overrides ConfigurationElement.OnDeserializeUnrecognizedElement(String, XmlReader).)
Protected methodOnRequiredPropertyNotFoundThrows an exception when a required property is not found. (Inherited from ConfigurationElement.)
Protected methodPostDeserializeCalled after deserialization. (Inherited from ConfigurationElement.)
Protected methodPreSerializeCalled before serialization. (Inherited from ConfigurationElement.)
Protected methodResetResets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Overrides ConfigurationElement.Reset(ConfigurationElement).)
Protected methodResetModifiedResets the value of the IsModified property to false when overridden in a derived class. (Overrides ConfigurationElement.ResetModified().)
Protected methodSerializeElementWrites the configuration data to an XML element in the configuration file when overridden in a derived class. (Overrides ConfigurationElement.SerializeElement(XmlWriter, Boolean).)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetPropertyValueSets a property to the specified value. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlyInfrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Overrides ConfigurationElement.SetReadOnly().)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeInfrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Overrides ConfigurationElement.Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode).)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the ConfigurationElementCollection to an array.
Top

The ConfigurationElementCollection represents a collection of elements within a configuration file.

NoteNote

An element within a configuration file refers to a basic XML element or a section. A simple element is an XML tag with related attributes, if any. A simple element constitutes a section. Complex sections can contain one or more simple elements, a collection of elements, and other sections.

You use the ConfigurationElementCollection to work with a collection of ConfigurationElement objects. Implement this class to add collections of custom ConfigurationElement elements to a ConfigurationSection.

Notes to Implementers

You can use a programmatic or a declarative (attributed) coding model to create a custom configuration element.

The programmatic model requires that for each element attribute you create a property to get and set its value, and that you add it to the internal property bag of the underlying ConfigurationElement base class.

The declarative model, also referred to as the attributed model, allows you to define an element attribute by using a property and configuring it with attributes. These attributes instruct the ASP.NET configuration system about the property types and their default values. ASP.NET can use reflection to obtain this information and then create the element property objects and perform the required initialization.

The following example shows how to use the ConfigurationCollectionElement.

The first example consists of three classes: UrlsSection, UrlsCollection and UrlConfigElement.The UrlsSection class uses the ConfigurationCollectionAttribute to define a custom configuration section. This section contains a URL collection (defined by the UrlsCollection class) of URL elements (defined by the UrlConfigElement class).

This second code example uses the classes specified before. You combine these two examples in a console application project.

When you run the console application, an instance of the UrlsSection class is created and the following configuration elements are generated in the application configuration file:

<configuration>
    <configSections>
        <section name="MyUrls" type="UrlsSection, 
          ConfigurationElementCollection, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
    </configSections>
    <MyUrls>
        <urls>
           <add name="Contoso" url="http://www.contoso.com" port="4040 />
        </urls>
    </MyUrls>
</configuration

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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.

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

System.Object
  System.Configuration.ConfigurationElement
    System.Configuration.ConfigurationElementCollection
      System.Configuration.ConnectionStringSettingsCollection
      System.Configuration.KeyValueConfigurationCollection
      System.Configuration.NameValueConfigurationCollection
      System.Configuration.ProviderSettingsCollection
      System.Configuration.SchemeSettingElementCollection
      System.Configuration.SettingElementCollection
      System.Net.Configuration.AuthenticationModuleElementCollection
      System.Net.Configuration.BypassElementCollection
      System.Net.Configuration.ConnectionManagementElementCollection
      System.Net.Configuration.WebRequestModuleElementCollection
      System.Runtime.Caching.Configuration.MemoryCacheSettingsCollection
      System.Runtime.Serialization.Configuration.DeclaredTypeElementCollection
      System.Runtime.Serialization.Configuration.ParameterElementCollection
      System.Runtime.Serialization.Configuration.TypeElementCollection
      System.Security.Authentication.ExtendedProtection.Configuration.ServiceNameElementCollection
      System.ServiceModel.Activities.Tracking.Configuration.TrackingConfigurationCollection<TConfigurationElement>
      System.ServiceModel.Configuration.ServiceModelConfigurationElementCollection<ConfigurationElementType>
      System.ServiceModel.Routing.Configuration.BackupEndpointCollection
      System.ServiceModel.Routing.Configuration.BackupListCollection
      System.ServiceModel.Routing.Configuration.FilterElementCollection
      System.ServiceModel.Routing.Configuration.FilterTableCollection
      System.ServiceModel.Routing.Configuration.FilterTableEntryCollection
      System.ServiceModel.Routing.Configuration.NamespaceElementCollection
      System.Web.Configuration.AssemblyCollection
      System.Web.Configuration.AuthorizationRuleCollection
      System.Web.Configuration.BufferModesCollection
      System.Web.Configuration.BuildProviderCollection
      System.Web.Configuration.ClientTargetCollection
      System.Web.Configuration.CodeSubDirectoriesCollection
      System.Web.Configuration.CompilerCollection
      System.Web.Configuration.ConvertersCollection
      System.Web.Configuration.CustomErrorCollection
      System.Web.Configuration.EventMappingSettingsCollection
      System.Web.Configuration.ExpressionBuilderCollection
      System.Web.Configuration.FolderLevelBuildProviderCollection
      System.Web.Configuration.FormsAuthenticationUserCollection
      System.Web.Configuration.FullTrustAssemblyCollection
      System.Web.Configuration.HttpHandlerActionCollection
      System.Web.Configuration.HttpModuleActionCollection
      System.Web.Configuration.IgnoreDeviceFilterElementCollection
      System.Web.Configuration.NamespaceCollection
      System.Web.Configuration.OutputCacheProfileCollection
      System.Web.Configuration.PartialTrustVisibleAssemblyCollection
      System.Web.Configuration.ProfileGroupSettingsCollection
      System.Web.Configuration.ProfilePropertySettingsCollection
      System.Web.Configuration.ProfileSettingsCollection
      System.Web.Configuration.ProtocolCollection
      System.Web.Configuration.RuleSettingsCollection
      System.Web.Configuration.SqlCacheDependencyDatabaseCollection
      System.Web.Configuration.TagMapCollection
      System.Web.Configuration.TagPrefixCollection
      System.Web.Configuration.TransformerInfoCollection
      System.Web.Configuration.TrustLevelCollection
      System.Web.Configuration.UrlMappingCollection
      System.Web.Mobile.DeviceFilterElementCollection
      System.Web.Services.Configuration.ProtocolElementCollection
      System.Web.Services.Configuration.SoapExtensionTypeElementCollection
      System.Web.Services.Configuration.TypeElementCollection
      System.Web.Services.Configuration.WsiProfilesElementCollection
      System.Web.UI.MobileControls.ControlElementCollection
      System.Web.UI.MobileControls.DeviceElementCollection
      System.Workflow.Runtime.Configuration.WorkflowRuntimeServiceElementCollection
      System.Xaml.Hosting.Configuration.HandlerElementCollection
      System.Xml.Serialization.Configuration.SchemaImporterExtensionElementCollection

Community Additions

ADD
Show:
© 2014 Microsoft