KeyValueConfigurationElement Class
Represents a configuration element that contains a key/value pair.
Assembly: System.Configuration (in System.Configuration.dll)
System.Configuration.ConfigurationElement
System.Configuration.KeyValueConfigurationElement
| Name | Description | |
|---|---|---|
![]() | KeyValueConfigurationElement(String, String) | Initializes a new instance of the KeyValueConfigurationElement class based on the supplied parameters. |
| Name | Description | |
|---|---|---|
![]() | 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.) |
![]() | EvaluationContext | Gets the ContextInformation object for the ConfigurationElement object.(Inherited from ConfigurationElement.) |
![]() | HasContext | (Inherited from ConfigurationElement.) |
![]() | 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.) |
![]() | Key | Gets the key of the KeyValueConfigurationElement object. |
![]() | 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 | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of properties. (Overrides ConfigurationElement.Properties.) |
![]() | Value | Gets or sets the value of the KeyValueConfigurationElement object. |
| Name | Description | |
|---|---|---|
![]() | DeserializeElement(XmlReader, Boolean) | Reads XML from the configuration file.(Inherited from ConfigurationElement.) |
![]() | Equals(Object) | Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Gets a unique value representing the current ConfigurationElement instance.(Inherited from ConfigurationElement.) |
![]() | 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() | |
![]() | Init() | This API supports the product infrastructure and is not intended to be used directly from your code. Sets the KeyValueConfigurationElement object to its initial state.(Overrides ConfigurationElement.Init().) |
![]() | InitializeDefault() | Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.) |
![]() | IsModified() | Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.(Inherited from ConfigurationElement.) |
![]() | IsReadOnly() | Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.) |
![]() | ListErrors(IList) | Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.(Inherited from ConfigurationElement.) |
![]() | MemberwiseClone() | |
![]() | OnDeserializeUnrecognizedAttribute(String, String) | Gets a value indicating whether an unknown attribute is encountered during deserialization.(Inherited from ConfigurationElement.) |
![]() | OnDeserializeUnrecognizedElement(String, XmlReader) | Gets a value indicating whether an unknown element is encountered during deserialization.(Inherited from ConfigurationElement.) |
![]() | 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.) |
![]() | Reset(ConfigurationElement) | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.) |
![]() | ResetModified() | Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationElement.) |
![]() | SerializeElement(XmlWriter, Boolean) | Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.) |
![]() | 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 ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.) |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
![]() | Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.) |
The KeyValueConfigurationElement object inherits from the ConfigurationElement base class. The ConfigurationElement object represents an element within a configuration file. The KeyValueConfigurationElement object can belong in a KeyValueConfigurationCollection collection.
The following code example demonstrates how to use members of the KeyValueConfigurationElement class.
using System; using System.Collections.Generic; using System.Text; using System.Configuration; using System.Web; using System.Web.Configuration; namespace Samples.Aspnet.Config { class KeyValueConfigCollection { static void Main(string[] args) { try { // Set the path of the config file. string configPath = "/aspnet"; // Get the Web application configuration object. Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath); // Get the section related object. AppSettingsSection configSection = (AppSettingsSection)config.GetSection ("appSettings"); // 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.ToString()); Console.WriteLine(); // Create the KeyValueConfigurationElement. KeyValueConfigurationElement myAdminKeyVal = new KeyValueConfigurationElement( "myAdminTool", "admin.aspx"); // Determine if the configuration contains // any KeyValueConfigurationElements. KeyValueConfigurationCollection configSettings = config.AppSettings.Settings; if (configSettings.AllKeys.Length == 0) { // Add KeyValueConfigurationElement to collection. config.AppSettings.Settings.Add(myAdminKeyVal); if (!configSection.SectionInformation.IsLocked) { config.Save(); Console.WriteLine("** Configuration updated."); } else { Console.WriteLine("** Could not update, section is locked."); } } // Get the KeyValueConfigurationCollection // from the configuration. KeyValueConfigurationCollection settings = config.AppSettings.Settings; // Display each KeyValueConfigurationElement. foreach (KeyValueConfigurationElement keyValueElement in settings) { Console.WriteLine("Key: {0}", keyValueElement.Key); Console.WriteLine("Value: {0}", keyValueElement.Value); Console.WriteLine(); } } catch (Exception e) { // Unknown error. Console.WriteLine(e.ToString()); } // Display and wait Console.ReadLine(); } } }
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.



