SectionInformation.ForceDeclaration Method (Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Forces the associated configuration section to appear in the configuration file, or removes an existing section from the configuration file.

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

public void ForceDeclaration(
	bool force
)

Parameters

force
Type: System.Boolean

true if the associated section should be written in the configuration file; otherwise, false.

Exception Condition
ConfigurationErrorsException

force is true and the associated section cannot be exported to the child configuration file, or it is undeclared.

The ForceDeclaration method forces this SectionInformation declaration to be written to the configuration file if force is true. If force is false, this action might be ignored if the SectionInformation declaration is required by the system.

System_CAPS_noteNote

The ForceDeclaration method can force a SectionInformation declaration to be written to a configuration file, even if this section is not required because it is already declared in a parent file. Using the ForceDeclaration method can make a configuration file more portable from one computer to another. This also lets you make sure that the section exists even if you do not have control over parent configuration files.

The following example shows how to use the ForceDeclaration method.

// Force the section information to be written to
// the configuration file.
section.SectionInformation.ForceDeclaration(true);

.NET Framework
Available since 2.0
Return to top
Show: