Export (0) Print
Expand All

KeyValueConfigurationCollection Class

Contains a collection of KeyValueConfigurationElement objects.

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

[<ConfigurationCollectionAttribute(typeof(KeyValueConfigurationElement))>]
type KeyValueConfigurationCollection =  
    class 
        inherit ConfigurationElementCollection 
    end

The KeyValueConfigurationCollection type exposes the following members.

  NameDescription
Public methodKeyValueConfigurationCollectionInitializes a new instance of the KeyValueConfigurationCollection 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. (Inherited from ConfigurationElementCollection.)
Public propertyAllKeysGets the keys to all items contained in the KeyValueConfigurationCollection collection.
Protected propertyClearElementNameGets 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.)
Public propertyCollectionTypeGets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public propertyCountGets the number of elements in the collection. (Inherited from ConfigurationElementCollection.)
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. (Inherited from ConfigurationElementCollection.)
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. (Inherited from ConfigurationElementCollection.)
Protected propertyEvaluationContextGets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyHasContextGets a value that indicates whether the CurrentConfiguration property is a null reference (Nothing in Visual Basic). (Inherited from ConfigurationElement.)
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection.)
Protected propertyItem(ConfigurationProperty)Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Public propertyItem(String)Gets the KeyValueConfigurationElement object based on the supplied parameter.
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 a collection of configuration properties. (Overrides ConfigurationElement.Properties.)
Protected propertyRemoveElementNameGets 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.)
Public propertySyncRootGets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected propertyThrowOnDuplicateGets a value indicating whether an attempt to add a duplicate KeyValueConfigurationElement object to the KeyValueConfigurationCollection collection will cause an exception to be thrown. (Overrides ConfigurationElementCollection.ThrowOnDuplicate.)
Top

  NameDescription
Public methodAdd(KeyValueConfigurationElement)Adds a KeyValueConfigurationElement object to the collection based on the supplied parameters.
Public methodAdd(String, String)Adds a KeyValueConfigurationElement object to the collection based on the supplied parameters.
Protected methodBaseAdd(ConfigurationElement)Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseAdd(ConfigurationElement, Boolean)Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseAdd(Int32, ConfigurationElement)Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseClearRemoves all configuration element objects from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Int32)Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Object)Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetAllKeysReturns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetKeyGets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseIndexOfIndicates the index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection.)
Protected methodBaseIsRemovedIndicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveRemoves a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveAtRemoves the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Public methodClearClears the KeyValueConfigurationCollection collection.
Public methodCopyToCopies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.)
Protected methodCreateNewElement()When overridden in a derived class, the CreateNewElement method creates a new KeyValueConfigurationElement object. (Overrides ConfigurationElementCollection.CreateNewElement().)
Protected methodCreateNewElement(String)Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection.)
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. (Overrides ConfigurationElementCollection.GetElementKey(ConfigurationElement).)
Public methodGetEnumeratorInfrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public methodGetHashCodeGets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection.)
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. (Inherited from ConfigurationElementCollection.)
Protected methodIsElementRemovableIndicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodIsModifiedIndicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public methodIsReadOnlyIndicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection.)
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. (Inherited from ConfigurationElementCollection.)
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.)
Public methodRemoveRemoves a KeyValueConfigurationElement object from the collection.
Protected methodResetResets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodResetModifiedResets the value of the IsModified property to false when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodSerializeElementWrites the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
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. (Inherited from ConfigurationElementCollection.)
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 (Inherited from ConfigurationElementCollection.)
Top

This class represents a collection of pairs, where each pair consists of a string serving as a collection key and a string value. Because the first element is a key, it must be unique across the collection.

The following code example demonstrates how to use the KeyValueConfigurationCollection type.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, 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.

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