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.)
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.
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.)
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 the default hash function. (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.)
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.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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft