ConfigurationSection.ShouldSerializePropertyInTargetVersion Method

.NET Framework 4.6 and 4.5

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)

'Declaration
Protected Friend Overridable Function ShouldSerializePropertyInTargetVersion ( _
	property As ConfigurationProperty, _
	propertyName As String, _
	targetFramework As FrameworkName, _
	parentConfigurationElement As ConfigurationElement _
) As Boolean

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.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft