This documentation is archived and is not being maintained.
SectionInformation Class
Visual Studio 2010
Contains metadata about an individual section within the configuration hierarchy. This class cannot be inherited.
Assembly: System.Configuration (in System.Configuration.dll)
The SectionInformation type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | AllowDefinition | Gets or sets a value that indicates where in the configuration file hierarchy the associated configuration section can be defined. |
![]() | AllowExeDefinition | Gets or sets a value that indicates where in the configuration file hierarchy the associated configuration section can be declared. |
![]() | AllowLocation | Gets or sets a value that indicates whether the configuration section allows the location attribute. |
![]() | AllowOverride | Gets or sets a value that indicates whether the associated configuration section can be overridden by lower-level configuration files. |
![]() | ConfigSource | Gets or sets the name of the include file in which the associated configuration section is defined, if such a file exists. |
![]() | ForceSave | Gets or sets a value that indicates whether the associated configuration section will be saved even if it has not been modified. |
![]() | InheritInChildApplications | Gets 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. |
![]() | IsDeclarationRequired | Gets a value that indicates whether the configuration section must be declared in the configuration file. |
![]() | IsDeclared | Gets a value that indicates whether the associated configuration section is declared in the configuration file. |
![]() | IsLocked | Gets a value that indicates whether the associated configuration section is locked. |
![]() | IsProtected | Gets a value that indicates whether the associated configuration section is protected. |
![]() | Name | Gets the name of the associated configuration section. |
![]() | OverrideMode | Gets or sets the OverrideMode enumeration value that specifies whether the associated configuration section can be overridden by child configuration files. |
![]() | OverrideModeDefault | Gets or sets a value that specifies the default override behavior of a configuration section by child configuration files. |
![]() | OverrideModeEffective | Gets the override behavior of a configuration section that is in turn based on whether child configuration files can lock the configuration section. |
![]() | ProtectionProvider | Gets the protected configuration provider for the associated configuration section. |
![]() | RequirePermission | Gets a value that indicates whether the associated configuration section requires access permissions. |
![]() | RestartOnExternalChanges | Gets or sets a value that specifies whether a change in an external configuration include file requires an application restart. |
![]() | SectionName | Gets the name of the associated configuration section. |
![]() | Type | Gets or sets the section class name. |
| Name | Description | |
|---|---|---|
![]() | 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.) |
![]() | ForceDeclaration | Forces the associated configuration section to appear in the configuration file. |
![]() | ForceDeclaration(Boolean) | Forces the associated configuration section to appear in the configuration file, or removes an existing section from the configuration file. |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetParentSection | Gets the configuration section that contains the configuration section associated with this object. |
![]() | GetRawXml | Infrastructure. Returns an XML node object that represents the associated configuration-section object. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ProtectSection | Marks a configuration section for protection. |
![]() | RevertToParent | Causes the associated configuration section to inherit all its values from the parent section. |
![]() | SetRawXml | Infrastructure. Sets the object to an XML representation of the associated configuration section within the configuration file. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | UnprotectSection | Removes the protected configuration encryption from the associated configuration section. |
The following example shows how to get the SectionInformation metadata that is associated with a ConfigurationSection object.
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
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>
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.
Show:
