ConfigurationElement.SerializeToXmlElement Method (System.Configuration)

Microsoft Developer Network

SerializeToXmlElement Method

.NET Framework Class Library

ConfigurationElement..::.SerializeToXmlElement Method

Writes the outer tags 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 SerializeToXmlElement ( _
    writer As XmlWriter, _
    elementName As String _
) As Boolean

Visual Basic (Usage)

Dim writer As XmlWriter
Dim elementName As String
Dim returnValue As Boolean

returnValue = Me.SerializeToXmlElement(writer, _
    elementName)

protected internal virtual bool SerializeToXmlElement(
    XmlWriter writer,
    string elementName
)

Visual C++

protected public:
virtual bool SerializeToXmlElement(
    XmlWriter^ writer, 
    String^ elementName
)

JScript

protected internal function SerializeToXmlElement(
    writer : XmlWriter, 
    elementName : String
) : boolean

Parameters

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

elementName: Type: System..::.String
The name of the ConfigurationElement to be written.

Return Value

Type: System..::.Boolean
true if writing was successful; otherwise, false.

Exceptions

Exception	Condition
Exception	The element has multiple child elements.

Remarks

The SerializeToXmlElement method is called after the call to the Unmerge method during serialization. The SerializeToXmlElement method writes out the contents of the configuration element between the beginning and ending tags of the element. Override SerializeToXmlElement to provide a custom serialization method.

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