Export (0) Print
Expand All

IXmlSerializable.WriteXml Method

Converts an object into its XML representation.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

'Declaration
Sub WriteXml ( _
	writer As XmlWriter _
)
'Usage
Dim instance As IXmlSerializable
Dim writer As XmlWriter

instance.WriteXml(writer)
void WriteXml (
	XmlWriter writer
)
function WriteXml (
	writer : XmlWriter
)
Not applicable.

Parameters

writer

The XmlWriter stream to which the object is serialized.

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.

The following example illustrates an implementation of the WriteXml method.

No code example is currently available or this language may not be supported.
public void WriteXml(XmlWriter writer)
{
    writer.WriteString(personName);
} //WriteXml

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

No code example is currently available or this language may not be supported.
import System.*;
import System.Xml.*;
import System.Xml.Serialization.*;
import System.Xml.Schema.*;

public class Writer
{
    public static void main(String[] args)
    {
        // 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(Person.class.ToType());
        serializer.Serialize(writer, fred);
    } //main
} //Writer 

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft