ConfigurationElementCollection Class
Represents a configuration element containing a collection of child elements.
System.Configuration.ConfigurationElement
System.Configuration.ConfigurationElementCollection
More...
Assembly: System.Configuration (in System.Configuration.dll)
The ConfigurationElementCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ConfigurationElementCollection() | Initializes a new instance of the ConfigurationElementCollection class. |
![]() | ConfigurationElementCollection(IComparer) | Creates a new instance of the ConfigurationElementCollection class. |
| Name | Description | |
|---|---|---|
![]() | AddElementName | Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. |
![]() | ClearElementName | Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. |
![]() | CollectionType | Gets the type of the ConfigurationElementCollection. |
![]() | Count | Gets the number of elements in the collection. |
![]() | 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. |
![]() | 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. |
![]() | EvaluationContext | Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | IsSynchronized | Gets a value indicating whether access to the collection is synchronized (thread safe). |
![]() | Item(ConfigurationProperty) | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
![]() | Item(String) | Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.) |
![]() | 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. |
![]() | SyncRoot | Gets an object used to synchronize access to the ConfigurationElementCollection. |
![]() | ThrowOnDuplicate | Gets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown. |
| Name | Description | |
|---|---|---|
![]() | BaseAdd(ConfigurationElement) | Adds a configuration element to the ConfigurationElementCollection. |
![]() | BaseAdd(ConfigurationElement, Boolean) | Adds a configuration element to the configuration element collection. |
![]() | BaseAdd(Int32, ConfigurationElement) | Adds a configuration element to the configuration element collection. |
![]() | BaseClear | Removes all configuration element objects from the collection. |
![]() | BaseGet(Int32) | Gets the configuration element at the specified index location. |
![]() | BaseGet(Object) | Returns the configuration element with the specified key. |
![]() | BaseGetAllKeys | Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. |
![]() | BaseGetKey | Gets the key for the ConfigurationElement at the specified index location. |
![]() | BaseIndexOf | The index of the specified ConfigurationElement. |
![]() | BaseIsRemoved | Gets a value indicating whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. |
![]() | BaseRemove | Removes a ConfigurationElement from the collection. |
![]() | BaseRemoveAt | Removes the ConfigurationElement at the specified index location. |
![]() | CopyTo | Copies the contents of the ConfigurationElementCollection to an array. |
![]() | CreateNewElement() | When overridden in a derived class, creates a new ConfigurationElement. |
![]() | CreateNewElement(String) | Creates a new ConfigurationElement when overridden in a derived class. |
![]() | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
![]() | Equals | Compares the ConfigurationElementCollection to the specified object. (Overrides ConfigurationElement.Equals(Object).) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetElementKey | Gets the element key for a specified configuration element when overridden in a derived class. |
![]() | GetEnumerator | Infrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. |
![]() | GetHashCode | Gets a unique value representing the ConfigurationElementCollection instance. (Overrides ConfigurationElement.GetHashCode().) |
![]() | GetTransformedAssemblyString | Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.) |
![]() | GetTransformedTypeString | 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 | Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. |
![]() | IsElementRemovable | Gets a value indicating whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. |
![]() | IsModified | Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Overrides ConfigurationElement.IsModified().) |
![]() | IsReadOnly | Gets a value indicating whether the ConfigurationElementCollection object is read only. (Overrides ConfigurationElement.IsReadOnly().) |
![]() | ListErrors | 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 | Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.) |
![]() | OnDeserializeUnrecognizedElement | Causes the configuration system to throw an exception. (Overrides ConfigurationElement.OnDeserializeUnrecognizedElement(String, XmlReader).) |
![]() | OnRequiredPropertyNotFound | Throws an exception when a required property is not found. (Inherited from ConfigurationElement.) |
![]() | PostDeserialize | Called after deserialization. (Inherited from ConfigurationElement.) |
![]() | PreSerialize | Called before serialization. (Inherited from ConfigurationElement.) |
![]() | Reset | Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Overrides ConfigurationElement.Reset(ConfigurationElement).) |
![]() | ResetModified | Resets the value of the IsModified property to false when overridden in a derived class. (Overrides ConfigurationElement.ResetModified().) |
![]() | SerializeElement | Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Overrides ConfigurationElement.SerializeElement(XmlWriter, Boolean).) |
![]() | SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SetPropertyValue | Sets a property to the specified value. (Inherited from ConfigurationElement.) |
![]() | SetReadOnly | Infrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Overrides ConfigurationElement.SetReadOnly().) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Unmerge | Infrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Overrides ConfigurationElement.Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode).) |
| Name | Description | |
|---|---|---|
![]() | AsParallel | Enables parallelization of a query. (Defined by ParallelEnumerable.) |
![]() | AsQueryable | Converts an IEnumerable to an IQueryable. (Defined by Queryable.) |
![]() | Cast(TResult) | Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.) |
![]() | OfType(TResult) | Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.) |
The ConfigurationElementCollection represents a collection of elements within a configuration file.
Note |
|---|
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 ImplementersYou 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
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.
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
