This documentation is archived and is not being maintained.

ConfigurationSectionCollection Class

Represents a collection of related sections within a configuration file.

System::Object
  System.Collections.Specialized::NameObjectCollectionBase
    System.Configuration::ConfigurationSectionCollection

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

[SerializableAttribute]
public ref class ConfigurationSectionCollection sealed : public NameObjectCollectionBase

The ConfigurationSectionCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of sections in this ConfigurationSectionCollection object. (Overrides NameObjectCollectionBase::Count.)
Protected propertyIsReadOnlyGets or sets a value indicating whether the NameObjectCollectionBase instance is read-only. (Inherited from NameObjectCollectionBase.)
Public propertyItem[Int32]Gets the specified ConfigurationSection object.
Public propertyItem[String]Gets the specified ConfigurationSection object.
Public propertyKeysGets the keys to all ConfigurationSection objects contained in this ConfigurationSectionCollection object. (Overrides NameObjectCollectionBase::Keys.)
Top

  NameDescription
Public methodAddAdds a ConfigurationSection object to the ConfigurationSectionCollection object.
Protected methodBaseAddAdds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseClearRemoves all entries from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGet(Int32)Gets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGet(String)Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetAllKeysReturns a String array that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetAllValues()Returns an Object array that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetAllValues(Type)Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetKeyGets the key of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseHasKeysGets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not nullptr. (Inherited from NameObjectCollectionBase.)
Protected methodBaseRemoveRemoves the entries with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseRemoveAtRemoves the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseSet(Int32, Object)Sets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseSet(String, Object)Sets the value of the first entry with the specified key in the NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Public methodClearClears this ConfigurationSectionCollection object.
Public methodCopyToCopies this ConfigurationSectionCollection object to an array.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from 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.)
Public methodGet(Int32)Gets the specified ConfigurationSection object contained in this ConfigurationSectionCollection object.
Public methodGet(String)Gets the specified ConfigurationSection object contained in this ConfigurationSectionCollection object.
Public methodGetEnumeratorGets an enumerator that can iterate through this ConfigurationSectionCollection object. (Overrides NameObjectCollectionBase::GetEnumerator().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetKeyGets the key of the specified ConfigurationSection object contained in this ConfigurationSectionCollection object.
Public methodGetObjectDataUsed by the system during serialization. (Overrides NameObjectCollectionBase::GetObjectData(SerializationInfo, StreamingContext).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnDeserializationImplements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase.)
Public methodRemoveRemoves the specified ConfigurationSection object from this ConfigurationSectionCollection object.
Public methodRemoveAtRemoves the specified ConfigurationSection object from this ConfigurationSectionCollection object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection::CopyToCopies the entire NameObjectCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from NameObjectCollectionBase.)
Explicit interface implemetationPrivate propertyICollection::IsSynchronizedGets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe). (Inherited from NameObjectCollectionBase.)
Explicit interface implemetationPrivate propertyICollection::SyncRootGets an object that can be used to synchronize access to the NameObjectCollectionBase object. (Inherited from NameObjectCollectionBase.)
Top

Use the ConfigurationSectionCollection class to iterate through a collection of ConfigurationSection objects. You can access this collection of objects using the Sections property or the Sections property.

The ConfigurationSectionCollection class is also used in the creation of custom types that extend the ConfigurationSection class.

The following code example shows how to use the ConfigurationSectionCollection class.

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

The following example is an excerpt of the configuration file used by the previous example.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>

    <section name="CustomSection" 
      type="Samples.AspNet.Configuration.CustomSection, ConfigurationSectionCollection, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" allowDefinition="Everywhere" allowExeDefinition="MachineToApplication" restartOnExternalChanges="true" />

  </configSections>

  <CustomSection fileName="default.txt" maxUsers="1000" 
    maxIdleTime="00:05:00" />

</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.
Show: