NameValueConfigurationCollection Class
Contains a collection of NameValueConfigurationElement objects. This class cannot be inherited.
System.Configuration.ConfigurationElement
System.Configuration.ConfigurationElementCollection
System.Configuration.NameValueConfigurationCollection
Namespace: System.Configuration
Assembly: System.Configuration (in System.Configuration.dll)
The NameValueConfigurationCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | NameValueConfigurationCollection | Initializes a new instance of the NameValueConfigurationCollection 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. (Inherited from ConfigurationElementCollection.) |
![]() | AllKeys | Gets the keys to all items contained in the NameValueConfigurationCollection. |
![]() | 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.) |
![]() | 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.) |
![]() | 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[String] | Gets or sets the NameValueConfigurationElement object based on the supplied parameter. |
![]() | 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.) |
| Name | Description | |
|---|---|---|
![]() | Add | Adds a NameValueConfigurationElement object to the collection. |
![]() | BaseAdd(ConfigurationElement, Boolean) | 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 | Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.) |
![]() | BaseIsRemoved | Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
![]() | BaseRemove | Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.) |
![]() | BaseRemoveAt | Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.) |
![]() | Clear | Clears the NameValueConfigurationCollection. |
![]() | CopyTo | Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.) |
![]() | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
![]() | Equals | Compares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection.) |
![]() | GetEnumerator | Infrastructure. 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.) |
![]() | 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.) |
![]() | 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.) |
![]() | Remove(NameValueConfigurationElement) | Removes a NameValueConfigurationElement object from the collection based on the provided parameter. |
![]() | Remove(String) | Removes a NameValueConfigurationElement object from the collection based on the provided parameter. |
![]() | Reset | 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 | Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
![]() | SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SetReadOnly | Infrastructure. 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 | Infrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ICollection.CopyTo | Copies the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.) |
The NameValueConfigurationCollection class allows you to programmatically access a collection of NameValueConfigurationElement objects.
The following code example demonstrates how to use the NameValueConfigurationCollection type.
#region Using directives using System; using System.Configuration; using System.Web.Configuration; using System.Collections; using System.Text; #endregion namespace Samples.AspNet { class UsingNameValueConfigurationCollection { static void Main(string[] args) { try { // Set the path of the config file. // Make sure that you have a Web site on the // same server called TestConfig. string configPath = "/TestConfig"; // Get the Web application configuration object. Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath); // Get the section related object. AnonymousIdentificationSection configSection = (AnonymousIdentificationSection)config.GetSection ("system.web/anonymousIdentification"); // Display title and info. Console.WriteLine("Configuration Info"); Console.WriteLine(); // Display Config details. Console.WriteLine("File Path: {0}", config.FilePath); Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name); Console.WriteLine(); // Create a NameValueConfigurationCollection object. NameValueConfigurationCollection myNameValConfigCollection = new NameValueConfigurationCollection(); foreach (PropertyInformation propertyItem in configSection.ElementInformation.Properties) { // Assign domain name. if (propertyItem.Name == "domain") propertyItem.Value = "MyDomain"; if (propertyItem.Value != null) { // Enable SSL for cookie exchange. if (propertyItem.Name == "cookieRequireSSL") propertyItem.Value = true; NameValueConfigurationElement nameValConfigElement = new NameValueConfigurationElement (propertyItem.Name.ToString(), propertyItem.Value.ToString()); // Add a NameValueConfigurationElement // to the collection. myNameValConfigCollection.Add(nameValConfigElement); } } // Count property. Console.WriteLine("Collection Count: {0}", myNameValConfigCollection.Count); // Item property. Console.WriteLine("Value of property 'enabled': {0}", myNameValConfigCollection["enabled"].Value); // Display the contents of the collection. foreach (NameValueConfigurationElement configItem in myNameValConfigCollection) { Console.WriteLine(); Console.WriteLine("Configuration Details:"); Console.WriteLine("Name: {0}", configItem.Name); Console.WriteLine("Value: {0}", configItem.Value); } // Assign the domain calue. configSection.Domain = myNameValConfigCollection["domain"].Value; // Assign the SSL required value. if (myNameValConfigCollection["cookieRequireSSL"].Value == "true") configSection.CookieRequireSSL = true; // Remove domain from the collection. NameValueConfigurationElement myConfigElement = myNameValConfigCollection["domain"]; // Remove method. myNameValConfigCollection.Remove(myConfigElement); // Save changes to the configuration file. // This modifies the Web.config of the TestConfig site. config.Save(ConfigurationSaveMode.Minimal, true); // Clear the collection. myNameValConfigCollection.Clear(); } catch (Exception e) { // Unknown error. Console.WriteLine(e.ToString()); } // Display and wait. Console.ReadLine(); } } }
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
