This topic has not yet been rated - Rate this topic

ConfigurationElement.SerializeElement Method

.NET Framework 4

Other Versions

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

C++

Copy

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

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.

Copy


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;

}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ