This documentation is archived and is not being maintained.

ConfigurationSectionGroup.ForceDeclaration Method (Boolean)

Forces the declaration for this ConfigurationSectionGroup object.

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

public void ForceDeclaration(
	bool force
)

Parameters

force
Type: System.Boolean

true if the ConfigurationSectionGroup object must be written to the file; otherwise, false.

ExceptionCondition
InvalidOperationException

The ConfigurationSectionGroup object is the root section group.

- or -

The ConfigurationSectionGroup object has a location.

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

The ForceDeclaration method can force a ConfigurationSectionGroup object to be written to a configuration file, even if it is not required because it is already declared in a parent file. Also, it can remove a group from a configuration file if the group is not required.

You might want to use the ForceDeclaration method to make a configuration file more portable from one computer to another, without worrying about whether the group declaration already exists.

The following code example shows how to use the ForceDeclaration method.

static void ForceDeclaration(
    ConfigurationSectionGroup sectionGroup,
    bool force)
{
    sectionGroup.ForceDeclaration(force);

    Console.WriteLine(
        "Forced declaration for the group: {0} is {1}",
        sectionGroup.Name, force.ToString());
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: