ConfigurationElement.SerializeElement Method (System.Configuration)

Microsoft Developer Network

SerializeElement Method

.NET Framework Class Library

ConfigurationElement..::.SerializeElement Method

Writes the contents of this configuration element to the configuration file when implemented in a derived class.

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

Syntax

Visual Basic (Declaration)

Protected Friend Overridable Function SerializeElement ( _
    writer As XmlWriter, _
    serializeCollectionKey As Boolean _
) As Boolean

Visual Basic (Usage)

Dim writer As XmlWriter
Dim serializeCollectionKey As Boolean
Dim returnValue As Boolean

returnValue = Me.SerializeElement(writer, _
    serializeCollectionKey)

protected internal virtual bool SerializeElement(
    XmlWriter writer,
    bool serializeCollectionKey
)

Visual C++

protected public:
virtual bool SerializeElement(
    XmlWriter^ writer, 
    bool serializeCollectionKey
)

JScript

protected internal function SerializeElement(
    writer : XmlWriter, 
    serializeCollectionKey : boolean
) : boolean

Parameters

writer: Type: System.Xml..::.XmlWriter
The XmlWriter that writes to the configuration file.

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

Return Value

Type: System..::.Boolean
true if any data was actually serialized; otherwise, false.

Exceptions

Exception	Condition
ConfigurationErrorsException	The current attribute is locked at a higher configuration level.

Examples

The following example shows how to extend the SerializeElement method.

Visual Basic

Protected Overrides Function SerializeElement(ByVal writer _
    As System.Xml.XmlWriter, _
    ByVal serializeCollectionKey As Boolean) As Boolean

    Dim ret As Boolean = _
        MyBase.SerializeElement(writer, serializeCollectionKey)
    ' Enter your custom processing code here.
    Return ret
End Function 'SerializeElement

protected override bool SerializeElement(
    System.Xml.XmlWriter writer, 
    bool serializeCollectionKey)
{
    bool ret = base.SerializeElement(writer, 
        serializeCollectionKey);
    // You can enter your custom processing code here.
    return ret;

}

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