ConfigurationSectionGroup.ForceDeclaration Method (Boolean)


Forces the declaration for this ConfigurationSectionGroup object.

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

Public Sub ForceDeclaration (
	force As Boolean


Type: System.Boolean

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

Exception Condition

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.

Overloads Shared Sub ForceDeclaration( _
ByVal sectionGroup _
As ConfigurationSectionGroup, _
ByVal force As Boolean)

    Console.WriteLine( _
    "Forced declaration for the group: {0} is {1}", _
    sectionGroup.Name, force.ToString())
End Sub 'ForceDeclaration

.NET Framework
Available since 2.0
Return to top