ConfigurationElement.OnDeserializeUnrecognizedElement Method (System.Configuration)

United States (English)

Home Library Learn Samples Downloads Support Community Forums

.NET Framework Class Library

ConfigurationElementOnDeserializeUnrecognizedElement Method

Gets a value indicating whether an unknown element is encountered during deserialization.

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

Syntax

Protected Overridable Function OnDeserializeUnrecognizedElement ( _
	elementName As [%$TOPIC/ms134132_en-us_VS_110_1_0_0_0_0%], _
	reader As [%$TOPIC/ms134132_en-us_VS_110_1_0_0_0_1%] _
) As [%$TOPIC/ms134132_en-us_VS_110_1_0_0_0_2%]

protected virtual [%$TOPIC/ms134132_en-us_VS_110_1_0_1_0_0%] OnDeserializeUnrecognizedElement(
	[%$TOPIC/ms134132_en-us_VS_110_1_0_1_0_1%] elementName,
	[%$TOPIC/ms134132_en-us_VS_110_1_0_1_0_2%] reader
)

protected:
virtual [%$TOPIC/ms134132_en-us_VS_110_1_0_2_0_0%] OnDeserializeUnrecognizedElement(
	[%$TOPIC/ms134132_en-us_VS_110_1_0_2_0_1%]^ elementName, 
	[%$TOPIC/ms134132_en-us_VS_110_1_0_2_0_2%]^ reader
)

abstract OnDeserializeUnrecognizedElement : 
        elementName:[%$TOPIC/ms134132_en-us_VS_110_1_0_3_0_0%] * 
        reader:[%$TOPIC/ms134132_en-us_VS_110_1_0_3_0_1%] -> [%$TOPIC/ms134132_en-us_VS_110_1_0_3_0_2%]  
override OnDeserializeUnrecognizedElement : 
        elementName:[%$TOPIC/ms134132_en-us_VS_110_1_0_3_0_3%] * 
        reader:[%$TOPIC/ms134132_en-us_VS_110_1_0_3_0_4%] -> [%$TOPIC/ms134132_en-us_VS_110_1_0_3_0_5%]

Parameters

elementName: Type: SystemString
The name of the unknown subelement.

reader: Type: System.XmlXmlReader
The XmlReader being used for deserialization.

Return Value

Type: SystemBoolean
true when an unknown element is encountered while deserializing; otherwise, false.

Exceptions

Exception	Condition
ConfigurationErrorsException	The element identified by elementName is locked. - or - One or more of the element's attributes is locked. - or - elementName is unrecognized, or the element has an unrecognized attribute. - or - The element has a Boolean attribute with an invalid value. - or - An attempt was made to deserialize a property more than once. - or - An attempt was made to deserialize a property that is not a valid member of the element. - or - The element cannot contain a CDATA or text element.

Exception

Condition

ConfigurationErrorsException

The element identified by elementName is locked.

- or -

One or more of the element's attributes is locked.

- or -

elementName is unrecognized, or the element has an unrecognized attribute.

- or -

The element has a Boolean attribute with an invalid value.

- or -

An attempt was made to deserialize a property more than once.

- or -

An attempt was made to deserialize a property that is not a valid member of the element.

- or -

The element cannot contain a CDATA or text element.

Remarks

The OnDeserializeUnrecognizedElement is invoked when an unknown attribute is encountered while deserializing the ConfigurationElement object.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

ConfigurationElement Class

System.Configuration Namespace