ConfigurationSection.ShouldSerializePropertyInTargetVersion Method

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

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

protected internal virtual bool ShouldSerializePropertyInTargetVersion(
	ConfigurationProperty property,
	string propertyName,
	FrameworkName targetFramework,
	ConfigurationElement parentConfigurationElement
)

Parameters

property
Type: System.Configuration.ConfigurationProperty

The ConfigurationProperty object that is a candidate for serialization.

propertyName
Type: System.String

The name of the ConfigurationProperty object as it occurs in XML.

targetFramework
Type: System.Runtime.Versioning.FrameworkName

The target version of the .NET Framework.

parentConfigurationElement
Type: System.Configuration.ConfigurationElement

The parent element of the property.

Return Value

Type: System.Boolean
true if the property should be serialized; otherwise, false.

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 specified property 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 all configuration properties that are contained in the configuration section will be serialized for all framework versions.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft