IXmlSerializable.WriteXml メソッド

.NET Framework クラス ライブラリ リファレンス

IXmlSerializable.WriteXml メソッド

オブジェクトを XML 表現に変換します。

名前空間: System.Xml.Serialization
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Sub WriteXml ( _
    writer As XmlWriter _
)

Visual Basic (使用法)

Dim instance As IXmlSerializable
Dim writer As XmlWriter

instance.WriteXml(writer)

C#

void WriteXml (
    XmlWriter writer
)

C++

void WriteXml (
    XmlWriter^ writer
)

J#

void WriteXml (
    XmlWriter writer
)

JScript

function WriteXml (
    writer : XmlWriter
)

パラメータ

writer

オブジェクトのシリアル化先の XmlWriter ストリーム。

解説

WriteXml を実装する場合は、オブジェクトの XML 表現を出力するように設計する必要があります。ラッパー要素はフレームワークによって書き込まれ、その開始位置の後に XML ライタが配置されます。実装側では、ここで XML の内容 (子要素を含む) を書き込むことになります。その後、フレームワークによって、ラッパー要素が閉じられます。

XmlWriter ストリームに、ReadXml メソッドがオブジェクトを再構築するために必要な情報を書き込みます。

たとえば、オブジェクトの状態に配列変数が含まれる場合は、オブジェクトの再構築時に読み取る値の数がわかるように、配列の長さを書き込むか、親要素を使用して配列の値を記述する要素を含める必要があります。

使用例

WriteXml メソッドの実装例を次に示します。

C#

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

C++

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

J#

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

XmlSerializer クラスを使用してこのオブジェクトを逆シリアル化する例を次に示します。

C#

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);
  }

}

C++

#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 );
}

J#

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 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
IXmlSerializable インターフェイス
IXmlSerializable メンバ
System.Xml.Serialization 名前空間