This documentation is archived and is not being maintained.

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)

protected internal virtual bool SerializeElement (
	XmlWriter writer,
	bool serializeCollectionKey
protected boolean SerializeElement (
	XmlWriter writer, 
	boolean serializeCollectionKey
protected internal function SerializeElement (
	writer : XmlWriter, 
	serializeCollectionKey : boolean
) : boolean
Not applicable.



The XmlWriter that writes to the configuration file.


true to serialize only the collection key properties; otherwise, false.

Return Value

true if any data was actually serialized; otherwise, false.

Exception typeCondition


The current attribute is locked at a higher configuration level.

The following example shows how to extend the SerializeElement method.

protected override bool SerializeElement(
    System.Xml.XmlWriter writer, 
    bool serializeCollectionKey)
    bool ret = base.SerializeElement(writer, 

    // Enter your custom processing code here.

    if (_displayIt)
            "UrlConfigElement.SerializeElement({0}, {1}) called = {2}",
            (writer == null) ? "null" : writer.ToString(),
            serializeCollectionKey.ToString(), ret.ToString());
    return ret;


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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0