IXmlSerializable.WriteXml(XmlWriter) Method

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.ReaderWriter.dll

Converts an object into its XML representation.

public:
 void WriteXml(System::Xml::XmlWriter ^ writer);

public void WriteXml (System.Xml.XmlWriter writer);

abstract member WriteXml : System.Xml.XmlWriter -> unit

Public Sub WriteXml (writer As XmlWriter)

Parameters

writer

XmlWriter

The XmlWriter stream to which the object is serialized.

Examples

The following example illustrates an implementation of the WriteXml method.

virtual void WriteXml( XmlWriter^ writer )
{
   writer->WriteString( personName );
}

public void WriteXml (XmlWriter writer)
{
    writer.WriteString(personName);
}

The following example illustrates the use of the XmlSerializer class to serialize this object.

#using <System.Xml.dll>
#using <System.dll>
#using <Person.dll>

using namespace System;
using namespace System::Xml;
using namespace System::Xml::Serialization;

int main()
{
   // Create a person object.
   Person ^ fred = gcnew Person( "Fred Flintstone" );

   // Serialize the object to a file.
   XmlTextWriter^ writer = gcnew XmlTextWriter( "test.xml", nullptr );
   XmlSerializer^ serializer = gcnew XmlSerializer( Person::typeid );
   serializer->Serialize( writer, fred );
}

using System;
using System.Xml;
using System.Xml.Serialization;

public class Writer {

  public static void Main() {

    // Create a person object.
    Person fred = new Person("Fred Flintstone");

    // Serialize the object to a file.
    XmlTextWriter writer = new XmlTextWriter("test.xml", null);
    XmlSerializer serializer = new XmlSerializer(typeof(Person));
    serializer.Serialize(writer, fred);
  }
}

Remarks

The WriteXml implementation you provide should write out the XML representation of the object. The framework writes a wrapper element and positions the XML writer after its start. Your implementation may write its contents, including child elements. The framework then closes the wrapper element.

Write sufficient information to the XmlWriter stream to allow the ReadXml method to reconstitute your object.

For example, if your object state includes an array variable, be sure to write the length of the array, or use a parent element to contain the elements that describe the array values, so that you know how many values to read when the object is reconstituted.