ConfigurationElement.SerializeElement(XmlWriter, Boolean) Method

Reference

Definition

Namespace:: System.Configuration

Assembly:: System.Configuration.ConfigurationManager.dll

Assembly:: System.Configuration.dll

Package:: System.Configuration.ConfigurationManager v10.0.0-preview.1.25080.5

Source:: ConfigurationElement.cs

Source:: ConfigurationElement.cs

Source:: ConfigurationElement.cs

Source:: ConfigurationElement.cs

Source:: ConfigurationElement.cs

Source:: ConfigurationElement.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

protected:
 virtual bool SerializeElement(System::Xml::XmlWriter ^ writer, bool serializeCollectionKey);

protected internal virtual bool SerializeElement(System.Xml.XmlWriter writer, bool serializeCollectionKey);

protected virtual bool SerializeElement(System.Xml.XmlWriter writer, bool serializeCollectionKey);

abstract member SerializeElement : System.Xml.XmlWriter * bool -> bool
override this.SerializeElement : System.Xml.XmlWriter * bool -> bool

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

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

Parameters

writer: XmlWriter

The XmlWriter that writes to the configuration file.

serializeCollectionKey: Boolean

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

Returns

Boolean

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

Exceptions

ConfigurationErrorsException

The current attribute is locked at a higher configuration level.

Examples

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, 
        serializeCollectionKey);
    // You can enter your custom processing code here.
    return ret;
}

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

Applies to

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via