ConfigurationElement.SerializeToXmlElement(XmlWriter, String) 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 outer tags of this configuration element to the configuration file when implemented in a derived class.

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

protected:
 virtual bool SerializeToXmlElement(System::Xml::XmlWriter ^ writer, System::String ^ elementName);

protected internal virtual bool SerializeToXmlElement(System.Xml.XmlWriter writer, string elementName);

protected virtual bool SerializeToXmlElement(System.Xml.XmlWriter writer, string elementName);

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

Protected Friend Overridable Function SerializeToXmlElement (writer As XmlWriter, elementName As String) As Boolean

Protected Overridable Function SerializeToXmlElement (writer As XmlWriter, elementName As String) As Boolean

Parameters

writer: XmlWriter

The XmlWriter that writes to the configuration file.

elementName: String

The name of the ConfigurationElement to be written.

Returns

Boolean

true if writing was successful; otherwise, false.

Exceptions

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.

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