SectionInformation.ConfigSource Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-rc.2.24473.5

Source:

SectionInformation.cs

Gets or sets the name of the include file in which the associated configuration section is defined, if such a file exists.

public:
 property System::String ^ ConfigSource { System::String ^ get(); void set(System::String ^ value); };

public string ConfigSource { get; set; }

member this.ConfigSource : string with get, set

Public Property ConfigSource As String

Property Value

String

The name of the include file in which the associated ConfigurationSection is defined, if such a file exists; otherwise, an empty string ("").

Remarks

The ConfigSource property represents the value of the configSource attribute that is specified for a ConfigurationSection object that is associated with the SectionInformation object.

A ConfigurationSection implementation can optionally specify a separate file in which the configuration settings for that section are defined. This can be useful in multiple ways:

• Using include files can result in a more logical and modular structure for configuration files.

• File-access security and permissions can be used to restrict access to sections of configuration settings.

• Settings in an include file that are not used during application initialization can be modified and reloaded without requiring an application restart.

The following example shows how this attribute is used in a configuration file to specify that the pages section is defined in an external include file:

<pages configSource="pages.config"/>

If any of the settings in a configuration include file require the application to restart when they are modified, set the RestartOnExternalChanges property to true.

In ASP.NET applications, at run time you can assign to the ConfigSource property the name of an alternative configuration file. In that case, the contents of the file are overwritten by the default connection string information that is contained in the Web.config file. This occurs also when the alternative file does not exist and it is created at run time. If the Web.config file does not contain any connection string information, an empty section is added to the alternative file.

See also

• RestartOnExternalChanges