ConfigurationSectionCollection Class
Represents a collection of related sections within a configuration file.
System.Collections.Specialized.NameObjectCollectionBase
System.Configuration.ConfigurationSectionCollection
Assembly: System.Configuration (in System.Configuration.dll)
The ConfigurationSectionCollection type exposes the following members.
| Name | Description | |
|---|---|---|
|
Count | Gets the number of sections in this ConfigurationSectionCollection object. (Overrides NameObjectCollectionBase.Count.) |
|
IsReadOnly | Gets or sets a value indicating whether the NameObjectCollectionBase instance is read-only. (Inherited from NameObjectCollectionBase.) |
|
Item[Int32] | Gets the specified ConfigurationSection object. |
|
Item[String] | Gets the specified ConfigurationSection object. |
|
Keys | Gets the keys to all ConfigurationSection objects contained in this ConfigurationSectionCollection object. (Overrides NameObjectCollectionBase.Keys.) |
| Name | Description | |
|---|---|---|
|
Add | Adds a ConfigurationSection object to the ConfigurationSectionCollection object. |
|
BaseAdd | Adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseClear | Removes all entries from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseGet(Int32) | Gets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseGet(String) | Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseGetAllKeys | Returns a String array that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseGetAllValues() | Returns an Object array that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseGetAllValues(Type) | Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseGetKey | Gets the key of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseHasKeys | Gets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not null. (Inherited from NameObjectCollectionBase.) |
|
BaseRemove | Removes the entries with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseRemoveAt | Removes the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseSet(Int32, Object) | Sets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
|
BaseSet(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.) |
|
Clear | Clears this ConfigurationSectionCollection object. |
|
CopyTo | Copies this ConfigurationSectionCollection object to an array. |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
Get(Int32) | Gets the specified ConfigurationSection object contained in this ConfigurationSectionCollection object. |
|
Get(String) | Gets the specified ConfigurationSection object contained in this ConfigurationSectionCollection object. |
|
GetEnumerator | Gets an enumerator that can iterate through this ConfigurationSectionCollection object. (Overrides NameObjectCollectionBase.GetEnumerator().) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetKey | Gets the key of the specified ConfigurationSection object contained in this ConfigurationSectionCollection object. |
|
GetObjectData | Used by the system during serialization. (Overrides NameObjectCollectionBase.GetObjectData(SerializationInfo, StreamingContext).) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnDeserialization | Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase.) |
|
Remove | Removes the specified ConfigurationSection object from this ConfigurationSectionCollection object. |
|
RemoveAt | Removes the specified ConfigurationSection object from this ConfigurationSectionCollection object. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
|
ICollection.CopyTo | Copies the entire NameObjectCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from NameObjectCollectionBase.) |
|
ICollection.IsSynchronized | Gets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe). (Inherited from NameObjectCollectionBase.) |
|
ICollection.SyncRoot | Gets an object that can be used to synchronize access to the NameObjectCollectionBase object. (Inherited from NameObjectCollectionBase.) |
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.
using System; using System.Configuration; using System.Collections; namespace Samples.AspNet.Configuration { // Define a custom section programmatically. public sealed class CustomSection : ConfigurationSection { // The collection (property bag) that contains // the section properties. private static ConfigurationPropertyCollection _Properties; // The FileName property. private static readonly ConfigurationProperty _FileName = new ConfigurationProperty("fileName", typeof(string), "default.txt", ConfigurationPropertyOptions.IsRequired); // The MasUsers property. private static readonly ConfigurationProperty _MaxUsers = new ConfigurationProperty("maxUsers", typeof(long), (long)1000, ConfigurationPropertyOptions.None); // The MaxIdleTime property. private static readonly ConfigurationProperty _MaxIdleTime = new ConfigurationProperty("maxIdleTime", typeof(TimeSpan), TimeSpan.FromMinutes(5), ConfigurationPropertyOptions.IsRequired); // CustomSection constructor. public CustomSection() { // Property initialization _Properties = new ConfigurationPropertyCollection(); _Properties.Add(_FileName); _Properties.Add(_MaxUsers); _Properties.Add(_MaxIdleTime); } // This is a key customization. // It returns the initialized property bag. protected override ConfigurationPropertyCollection Properties { get { return _Properties; } } [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\", MinLength = 1, MaxLength = 60)] public string FileName { get { return (string)this["fileName"]; } set { this["fileName"] = value; } } [LongValidator(MinValue = 1, MaxValue = 1000000, ExcludeRange = false)] public long MaxUsers { get { return (long)this["maxUsers"]; } set { this["maxUsers"] = value; } } [TimeSpanValidator(MinValueString = "0:0:30", MaxValueString = "5:00:0", ExcludeRange = false)] public TimeSpan MaxIdleTime { get { return (TimeSpan)this["maxIdleTime"]; } set { this["maxIdleTime"] = value; } } } class UsingCustomSectionCollection { // Create a custom section. static void CreateSection() { try { CustomSection customSection; // Get the current configuration file. System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); // Create the section entry // in the <configSections> and the // related target section in <configuration>. if (config.Sections["CustomSection"] == null) { customSection = new CustomSection(); config.Sections.Add("CustomSection", customSection); customSection.SectionInformation.ForceSave = true; config.Save(ConfigurationSaveMode.Full); } } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void GetAllKeys() { try { System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); ConfigurationSectionCollection sections = config.Sections; foreach (string key in sections.Keys) { Console.WriteLine( "Key value: {0}", key); } } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void Clear() { try { System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); config.Sections.Clear(); config.Save(ConfigurationSaveMode.Full); } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void GetSection() { try { CustomSection customSection = ConfigurationManager.GetSection( "CustomSection") as CustomSection; if (customSection == null) Console.WriteLine( "Failed to load CustomSection."); else { // Display section information Console.WriteLine("Defaults:"); Console.WriteLine("File Name: {0}", customSection.FileName); Console.WriteLine("Max Users: {0}", customSection.MaxUsers); Console.WriteLine("Max Idle Time: {0}", customSection.MaxIdleTime); } } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void GetEnumerator() { try { System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); ConfigurationSectionCollection sections = config.Sections; IEnumerator secEnum = sections.GetEnumerator(); int i = 0; while (secEnum.MoveNext()) { string setionName = sections.GetKey(i); Console.WriteLine( "Section name: {0}", setionName); i += 1; } } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void GetKeys() { try { System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); ConfigurationSectionCollection sections = config.Sections; foreach (string key in sections.Keys) { Console.WriteLine( "Key value: {0}", key); } } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void GetItems() { try { System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); ConfigurationSectionCollection sections = config.Sections; ConfigurationSection section1 = sections["runtime"]; ConfigurationSection section2 = sections[0]; Console.WriteLine( "Section1: {0}", section1.SectionInformation.Name); Console.WriteLine( "Section2: {0}", section2.SectionInformation.Name); } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void Remove() { try { System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); CustomSection customSection = config.GetSection( "CustomSection") as CustomSection; if (customSection != null) { config.Sections.Remove("CustomSection"); customSection.SectionInformation.ForceSave = true; config.Save(ConfigurationSaveMode.Full); } else Console.WriteLine( "CustomSection does not exists."); } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } static void AddSection() { try { System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); CustomSection customSection = new CustomSection(); string index = config.Sections.Count.ToString(); customSection.FileName = "newFile" + index + ".txt"; string sectionName = "CustomSection" + index; TimeSpan ts = new TimeSpan(0, 15, 0); customSection.MaxIdleTime = ts; customSection.MaxUsers = 100; config.Sections.Add(sectionName, customSection); customSection.SectionInformation.ForceSave = true; config.Save(ConfigurationSaveMode.Full); } catch (ConfigurationErrorsException err) { Console.WriteLine(err.ToString()); } } // Exercise the collection. // Uncomment the function you want to exercise. // Start with CreateSection(). static void Main(string[] args) { CreateSection(); // AddSection(); // GetSection(); // GetEnumerator(); // GetAllKeys(); // GetKeys(); // GetItems(); // Remove(); // Clear(); } } }
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>
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.