This topic has not yet been rated - Rate this topic

SectionInformation.ForceDeclaration Method (Boolean)

.NET Framework 4

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)

Syntax

C++

Copy

public void ForceDeclaration(
	bool force
)

Parameters

force: Type: System.Boolean
true if the associated section should be written in the configuration file; otherwise, false.

Exceptions

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

Remarks

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.

Note
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.

Note

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.

Examples

The following example shows how to use the ForceDeclaration method.

Copy


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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

SectionInformation Class

ForceDeclaration Overload

System.Configuration Namespace

IsDeclarationRequired

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ