ConfigurationElement.DeserializeElement Method (System.Configuration)

Microsoft Developer Network

DeserializeElement Method

.NET Framework Class Library

ConfigurationElement..::.DeserializeElement Method

Reads XML from the configuration file.

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

Syntax

Visual Basic (Declaration)

Protected Friend Overridable Sub DeserializeElement ( _
    reader As XmlReader, _
    serializeCollectionKey As Boolean _
)

Visual Basic (Usage)

Dim reader As XmlReader
Dim serializeCollectionKey As Boolean

Me.DeserializeElement(reader, serializeCollectionKey)

protected internal virtual void DeserializeElement(
    XmlReader reader,
    bool serializeCollectionKey
)

Visual C++

protected public:
virtual void DeserializeElement(
    XmlReader^ reader, 
    bool serializeCollectionKey
)

JScript

protected internal function DeserializeElement(
    reader : XmlReader, 
    serializeCollectionKey : boolean
)

Parameters

reader: Type: System.Xml..::.XmlReader
The XmlReader that reads from the configuration file.

serializeCollectionKey: Type: System..::.Boolean
true to serialize only the collection key properties; otherwise, false.

Exceptions

Exception	Condition
ConfigurationErrorsException	The element to read is locked. - or - An attribute of the current node is not recognized. - or - The lock status of the current node cannot be determined.

Exception

Condition

ConfigurationErrorsException

The element to read is locked.

- or -

An attribute of the current node is not recognized.

- or -

The lock status of the current node cannot be determined.

Examples

The following example demonstrates how to extend the DeserializeElement method.

Visual Basic

Protected Overrides Sub DeserializeElement(ByVal reader _
    As System.Xml.XmlReader, _
    ByVal serializeCollectionKey As Boolean)

    MyBase.DeserializeElement(reader, _
        serializeCollectionKey)
    ' Enter your custom processing code here.
End Sub 'DeserializeElement

protected override void DeserializeElement(
   System.Xml.XmlReader reader, 
    bool serializeCollectionKey)
{
    base.DeserializeElement(reader, 
        serializeCollectionKey);
    // You can your custom processing code here.
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

ConfigurationElement Class

ConfigurationElement Members

System.Configuration Namespace