Export (0) Print
Expand All

ConfigurationSectionGroup Class

Represents a group of related sections within a configuration file.

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

public class ConfigurationSectionGroup
public class ConfigurationSectionGroup
public class ConfigurationSectionGroup
Not applicable.

Because some configuration sections are related, it is often convenient to group them together within a single section group. The ConfigurationSectionGroup class represents the <sectionGroup> XML element within a configuration file.

Use the Sections property to access the sections contained in this ConfigurationSectionGroup object.

A ConfigurationSectionGroup object can also contain other ConfigurationSectionGroup objects, which can be accessed through the SectionGroups property.

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

using System;
using System.Collections;
using System.Configuration;

namespace Samples.AspNet
{
    class UsingConfigurationSectionGroup
    {
        static int indentLevel = 0;
        
        static void Main(string[] args)
        {

            // Get the application configuration file.
            System.Configuration.Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

            // Get the collection of the section groups.
            ConfigurationSectionGroupCollection 
                sectionGroups = config.SectionGroups;
            ShowSectionGroupCollectionInfo(sectionGroups);
        }
        
        static String getSpacer()
        {
            String spacer = "";
            for (int i = 0; i < indentLevel; i++)
            {
                spacer = spacer + "    ";
            }
            return spacer;
        }

        static void ForceDeclaration(
            ConfigurationSectionGroup sectionGroup)
        {

            // Get the application configuration file.
            System.Configuration.Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

            sectionGroup.ForceDeclaration();

            config.Save(ConfigurationSaveMode.Full);

            Console.WriteLine(
                "Forced declaration for the group: {0}", 
                sectionGroup.Name);
        }
        
        static void ForceDeclaration(
            ConfigurationSectionGroup sectionGroup, 
            bool force)
        {
            sectionGroup.ForceDeclaration(force);
           
            Console.WriteLine(
                "Forced declaration for the group: {0} is {1}",
                sectionGroup.Name, force.ToString());
        }
        
        static void ShowSectionGroupCollectionInfo(
            ConfigurationSectionGroupCollection sectionGroups)
        {
            foreach (String groupName in sectionGroups.Keys)
            {
                ConfigurationSectionGroup sectionGroup = 
                    (ConfigurationSectionGroup)sectionGroups[groupName];
                ShowSectionGroupInfo(sectionGroup);
                if (sectionGroup.Name == "system.web")
                {
                    ForceDeclaration(sectionGroup, true);
                }
             
            }
        }

        static void ShowSectionGroupInfo(
            ConfigurationSectionGroup sectionGroup)
        {
            // Get the group name including the 
            // parent group names.
            Console.WriteLine(getSpacer() + 
                "Section Group Name: " + 
                sectionGroup.Name);  

            // Get the group name without including
            // the parent group names.
            Console.WriteLine(getSpacer() +
                "Section Group Name: " + 
                sectionGroup.SectionGroupName);

            indentLevel++;
            
            Console.WriteLine(getSpacer() + 
                "Type: " + sectionGroup.Type);

            Console.WriteLine(getSpacer() +
                "Is Group Required?: " +
                sectionGroup.IsDeclarationRequired);            
            
            Console.WriteLine(getSpacer() + 
                "Is Group Declared?: " + 
                sectionGroup.IsDeclared);

            Console.WriteLine(getSpacer() + 
                "Contained Sections:");

            indentLevel++;
            
            ConfigurationSectionCollection sectionCollection = 
                sectionGroup.Sections;
            foreach (String sectionName in sectionCollection.Keys)
            {
                ConfigurationSection section = 
                    (ConfigurationSection)sectionCollection[sectionName];
                Console.WriteLine(getSpacer() + "Section Name:" 
                    + section.SectionInformation.Name);
            }

            indentLevel--;

            Console.WriteLine(getSpacer() + 
                "Contained Section Groups:");

            indentLevel++;

            ConfigurationSectionGroupCollection sectionGroups = 
                sectionGroup.SectionGroups;
            ShowSectionGroupCollectionInfo(sectionGroups);

            indentLevel--;
        }
    }

System.Object
  System.Configuration.ConfigurationSectionGroup
     Derived Classes

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft