SectionInformation Class (System.Configuration)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

SectionInformation Class

Contains metadata about an individual section within the configuration hierarchy. This class cannot be inherited.

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

Syntax

Visual Basic (Declaration)

Public NotInheritable Class SectionInformation

Visual Basic (Usage)

Dim instance As SectionInformation

public sealed class SectionInformation

Visual C++

public ref class SectionInformation sealed

JScript

public final class SectionInformation

Remarks

The SectionInformation object contains the metadata about an individual section within the configuration hierarchy. This object can be used in order to validate and change the properties of an individual section.

The SectionInformation class is introduced in the .NET Framework version 3.5 Service Pack 1. For more information, see .NET Framework 3.5 Architecture.

Examples

The following example shows how to get the SectionInformation metadata that is associated with a ConfigurationSection object.

Visual Basic

Public Shared Function GetSectionInformation() _
As SectionInformation

    ' Get the current configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)

    ' Get the section.
    Dim section As UrlsSection = _
    CType(config.GetSection("MyUrls"), UrlsSection)

    Dim sInfo As SectionInformation = _
    section.SectionInformation

    Return sInfo

End Function 'GetSectionInformation

static public SectionInformation 
    GetSectionInformation()
{

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

    // Get the section.
    UrlsSection section =
        (UrlsSection)config.GetSection("MyUrls");


    SectionInformation sInfo = 
        section.SectionInformation;

    return sInfo;

}

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

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="MyUrls" type="Samples.AspNet.UrlsSection,
      ConfigurationElement, Version=1.0.0.0, Culture=neutral,
      PublicKeyToken=null" allowDefinition="Everywhere"
      allowExeDefinition="MachineToApplication"
      restartOnExternalChanges="true" />
  </configSections>
  <MyUrls name="MyFavorites">
    <simple name="Contoso" url="http://www.contoso.com" port="8080" />
    <urls>
      <clear />
      <add name="Microsoft" url="http://www.microsoft.com" port="0" />
    </urls>
  </MyUrls>
</configuration>

Inheritance Hierarchy

System.Object
System.Configuration.SectionInformation

Thread Safety

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

Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

SectionInformation Members

System.Configuration Namespace

ConfigurationSection