Export (0) Print
Expand All

SectionInformation Class

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

System.Object
  System.Configuration.SectionInformation

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

public sealed class SectionInformation

The SectionInformation type exposes the following members.

  NameDescription
Public propertyAllowDefinitionGets or sets a value that indicates where in the configuration file hierarchy the associated configuration section can be defined.
Public propertyAllowExeDefinitionGets or sets a value that indicates where in the configuration file hierarchy the associated configuration section can be declared.
Public propertyAllowLocationGets or sets a value that indicates whether the configuration section allows the location attribute.
Public propertyAllowOverrideGets or sets a value that indicates whether the associated configuration section can be overridden by lower-level configuration files.
Public propertyConfigSourceGets or sets the name of the include file in which the associated configuration section is defined, if such a file exists.
Public propertyForceSaveGets or sets a value that indicates whether the associated configuration section will be saved even if it has not been modified.
Public propertyInheritInChildApplicationsGets or sets a value that indicates whether the settings that are specified in the associated configuration section are inherited by applications that reside in a subdirectory of the relevant application.
Public propertyIsDeclarationRequiredGets a value that indicates whether the configuration section must be declared in the configuration file.
Public propertyIsDeclaredGets a value that indicates whether the associated configuration section is declared in the configuration file.
Public propertyIsLockedGets a value that indicates whether the associated configuration section is locked.
Public propertyIsProtectedGets a value that indicates whether the associated configuration section is protected.
Public propertyNameGets the name of the associated configuration section.
Public propertyOverrideModeGets or sets the OverrideMode enumeration value that specifies whether the associated configuration section can be overridden by child configuration files.
Public propertyOverrideModeDefaultGets or sets a value that specifies the default override behavior of a configuration section by child configuration files.
Public propertyOverrideModeEffectiveGets the override behavior of a configuration section that is in turn based on whether child configuration files can lock the configuration section.
Public propertyProtectionProviderGets the protected configuration provider for the associated configuration section.
Public propertyRequirePermissionGets a value that indicates whether the associated configuration section requires access permissions.
Public propertyRestartOnExternalChangesGets or sets a value that specifies whether a change in an external configuration include file requires an application restart.
Public propertySectionNameGets the name of the associated configuration section.
Public propertyTypeGets or sets the section class name.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodForceDeclaration()Forces the associated configuration section to appear in the configuration file.
Public methodForceDeclaration(Boolean)Forces the associated configuration section to appear in the configuration file, or removes an existing section from the configuration file.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetParentSectionGets the configuration section that contains the configuration section associated with this object.
Public methodGetRawXmlInfrastructure. Returns an XML node object that represents the associated configuration-section object.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodProtectSectionMarks a configuration section for protection.
Public methodRevertToParentCauses the associated configuration section to inherit all its values from the parent section.
Public methodSetRawXmlInfrastructure. Sets the object to an XML representation of the associated configuration section within the configuration file.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUnprotectSectionRemoves the protected configuration encryption from the associated configuration section.
Top

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 following example shows how to get the SectionInformation metadata that is associated with a ConfigurationSection object.

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>

.NET Framework

Supported in: 4.5.3, 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.
Show:
© 2014 Microsoft