ConfigurationSection.ShouldSerializeSectionInTargetVersion Method

Definition

Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.

C#
protected internal virtual bool ShouldSerializeSectionInTargetVersion(System.Runtime.Versioning.FrameworkName targetFramework);
C#
protected virtual bool ShouldSerializeSectionInTargetVersion(System.Runtime.Versioning.FrameworkName targetFramework);

Parameters

targetFramework
FrameworkName

The target version of the .NET Framework.

Returns

true if the current section should be serialized; otherwise, false.

Remarks

Each configuration section that is created for the .NET Framework 4 and later versions must explicitly override this method and return true, but only if the configuration section is valid for the specified version of the .NET Framework. Existing configuration sections that were created for earlier versions of the .NET Framework do not have to be changed.

The base type contains a default implementation of this method that always returns true. If you implement a configuration section and you do not override this method, by default the configuration section will be serialized for all framework versions.

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0 (package-provided)
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

See also