XmlAttributeOverrides クラス

オブジェクトをシリアル化または逆シリアル化するために XmlSerializer を使用するときに、プロパティ、フィールド、クラスの各属性をユーザーがオーバーライドできるようにします。

この型のすべてのメンバの一覧については、XmlAttributeOverrides メンバ を参照してください。

System.Object
   System.Xml.Serialization.XmlAttributeOverrides

Public Class XmlAttributeOverrides
[C#]
public class XmlAttributeOverrides
[C++]
public __gc class XmlAttributeOverrides
[JScript]
public class XmlAttributeOverrides

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

XmlAttributeOverrides を使用すると、オブジェクトのセットをシリアル化する既定の方法を XmlSerializer でオーバーライドできるようになります。この方法でシリアル化をオーバーライドすることには 2 つの利点があります。第 1 に、DLL にアクセスしなくても、DLL 内のオブジェクトのシリアル化の制御および増大ができます。第 2 に、シリアル化できるクラスを 1 セット作成し、オブジェクトを複数の方法でシリアル化できます。たとえば、あるクラス インスタンスのメンバを XML 要素としてシリアル化する代わりに XML 属性としてシリアル化して、トランスポート効率の高いドキュメントにできます。

XmlAttributeOverrides オブジェクトを作成した後、このオブジェクトを引数として XmlSerializer コンストラクタに渡します。こうして得られた XmlSerializer は、 XmlAttributeOverrides が保持しているデータを使用して、オブジェクトがどのようにシリアル化されるかを制御する属性をオーバーライドします。そのためには、オーバーライドされるオブジェクト型のコレクションの他、オーバーライドされる各オブジェクト型に関連付けられている XmlAttributes オブジェクトが XmlAttributeOverrides に格納されている必要があります。 XmlAttributes オブジェクトそのものに、フィールド、プロパティ、またはクラスをどのようにシリアル化するかを制御する、属性オブジェクトの適切なセットが含まれています。

XmlAttributeOverrides オブジェクトの作成および使用手順は次のとおりです。

1. XmlAttributes オブジェクトを作成します。
2. オーバーライドされているオブジェクトに対して適切な属性オブジェクトを作成します。たとえば、フィールドまたはプロパティをオーバーライドするには、新しい派生型を使用して XmlElementAttribute を作成します。基本クラスの属性名または名前空間をオーバーライドする新しい ElementName または Namespace を、ユーザーがオプションとして割り当てることができます。
3. 適切な XmlAttributes のプロパティまたはコレクションに属性オブジェクトを追加します。たとえば、オーバーライドされるメンバ名を指定して XmlAttributes オブジェクトの XmlElements コレクションに XmlElementAttribute を追加します。
4. XmlAttributeOverrides オブジェクトを作成します。
5. Add メソッドを使用して XmlAttributes オブジェクトを XmlAttributeOverrides オブジェクトに追加します。オーバーライドされる予定のオブジェクトが XmlRootAttribute または XmlTypeAttribute である場合は、オーバーライドされるオブジェクトの型を指定するだけで済みます。ただし、フィールドまたはプロパティをオーバーライドする場合は、オーバーライドされるメンバの名前を指定する必要があります。
6. XmlSerializer を構築するときは、 XmlAttributeOverrides を XmlSerializer コンストラクタに渡します。
7. 結果として得られた XmlSerializer を使用して、派生クラス オブジェクトのシリアル化または逆シリアル化を行います。

使用例

[Visual Basic, C#, C++] Orchestra という名前のクラスをシリアル化する例を次に示します。この例には、Instrument オブジェクトの配列を返す Instruments という名前の単一のフィールドが含まれています。Brass という名前の 2 番目のクラスが Instrument クラスから継承されます。この例では、 XmlAttributeOverrides クラスのインスタンスを使用して Instrument フィールドをオーバーライドし、このフィールドが Brass オブジェクトを受け入れるようにします。

 
Option Explicit
Option Strict

Imports System
Imports System.IO
Imports System.Xml.Serialization
Imports Microsoft.VisualBasic


Public Class Orchestra
    Public Instruments() As Instrument
End Class

Public Class Instrument
    Public Name As String
End Class

Public Class Brass
    Inherits Instrument
    Public IsValved As Boolean
End Class

Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("Override.xml")
        test.DeserializeObject("Override.xml")
    End Sub
        
    Public Sub SerializeObject(ByVal filename As String)
        ' Each overridden field, property, or type requires
        ' an XmlAttributes object. 
        Dim attrs As New XmlAttributes()
        
        ' Create an XmlElementAttribute to override the
        ' field that returns Instrument objects. The overridden field
        ' returns Brass objects instead. 
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)
        
        ' Add the element to the collection of elements.
        attrs.XmlElements.Add(attr)
        
        ' Create the XmlAttributeOverrides object.
        Dim attrOverrides As New XmlAttributeOverrides()
        
        ' Add the type of the class that contains the overridden
        ' member and the XmlAttributes to override it with to the
        ' XmlAttributeOverrides object. 
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
        
        ' Create the XmlSerializer using the XmlAttributeOverrides.
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
        
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create the object that will be serialized.
        Dim band As New Orchestra()
        
        ' Create an object of the derived type.
        Dim i As New Brass()
        i.Name = "Trumpet"
        i.IsValved = True
        Dim myInstruments() As Instrument = {i}
        band.Instruments = myInstruments
        
        ' Serialize the object.
        s.Serialize(writer, band)
        writer.Close()
    End Sub    
    
    Public Sub DeserializeObject(filename As String)
        Dim attrOverrides As New XmlAttributeOverrides()
        Dim attrs As New XmlAttributes()
        
        ' Create an XmlElementAttribute to override the Instrument.
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)
        
        ' Add the XmlElementAttribute to the collection of objects.
        attrs.XmlElements.Add(attr)
        
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
        
        ' Create the XmlSerializer using the XmlAttributeOverrides.
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
        
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim band As Orchestra = CType(s.Deserialize(fs), Orchestra)
        Console.WriteLine("Brass:")
        
        ' The difference between deserializing the overridden
        ' XML document and serializing it is this: To read the derived
        ' object values, you must declare an object of the derived type
        ' (Brass), and cast the Instrument instance to it. 
        Dim b As Brass
        Dim i As Instrument
        For Each i In  band.Instruments
            b = CType(i, Brass)
            Console.WriteLine(b.Name & ControlChars.Cr & b.IsValved)
        Next i
    End Sub
End Class


[C#] 
using System;
using System.IO;
using System.Xml.Serialization;

public class Orchestra
{
   public Instrument[] Instruments;
}   

public class Instrument
{
   public string Name;
}

public class Brass:Instrument
{
   public bool IsValved;
}

public class Run
{
    public static void Main()
    {
       Run test = new Run();
       test.SerializeObject("Override.xml");
       test.DeserializeObject("Override.xml");
    }

    public void SerializeObject(string filename)
    {
      /* Each overridden field, property, or type requires 
      an XmlAttributes object. */
      XmlAttributes attrs = new XmlAttributes();

      /* Create an XmlElementAttribute to override the 
      field that returns Instrument objects. The overridden field
      returns Brass objects instead. */
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

      // Add the element to the collection of elements.
      attrs.XmlElements.Add(attr);

      // Create the XmlAttributeOverrides object.
      XmlAttributeOverrides attrOverrides = new XmlAttributeOverrides();

      /* Add the type of the class that contains the overridden 
      member and the XmlAttributes to override it with to the 
      XmlAttributeOverrides object. */
      attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s = 
      new XmlSerializer(typeof(Orchestra), attrOverrides);

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create the object that will be serialized.
      Orchestra band = new Orchestra();
      
      // Create an object of the derived type.
      Brass i = new Brass();
      i.Name = "Trumpet";
      i.IsValved = true;
      Instrument[] myInstruments = {i};
      band.Instruments = myInstruments;

      // Serialize the object.
      s.Serialize(writer,band);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlAttributeOverrides attrOverrides = 
         new XmlAttributeOverrides();
      XmlAttributes attrs = new XmlAttributes();

      // Create an XmlElementAttribute to override the Instrument.
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

      // Add the XmlElementAttribute to the collection of objects.
      attrs.XmlElements.Add(attr);

      attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s = 
      new XmlSerializer(typeof(Orchestra), attrOverrides);

      FileStream fs = new FileStream(filename, FileMode.Open);
      Orchestra band = (Orchestra) s.Deserialize(fs);
      Console.WriteLine("Brass:");

      /* The difference between deserializing the overridden 
      XML document and serializing it is this: To read the derived 
      object values, you must declare an object of the derived type 
      (Brass), and cast the Instrument instance to it. */
      Brass b;
      foreach(Instrument i in band.Instruments) 
      {
         b = (Brass)i;
         Console.WriteLine(
         b.Name + "\n" + 
         b.IsValved);
      }
   }
}


[C++] 
#using <mscorlib.dll>
#using <System.Xml.dll>
#using <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;

public __gc class Instrument
{
public:
   String* Name;
};

public __gc class Brass:public Instrument
{
public:
   bool IsValved;
};

public __gc class Orchestra
{
public:
   Instrument* Instruments[];
};   

void SerializeObject(String* filename)
{
   /* Each overridden field, property, or type requires 
   an XmlAttributes object. */
   XmlAttributes* attrs = new XmlAttributes();

   /* Create an XmlElementAttribute to override the 
   field that returns Instrument objects. The overridden field
   returns Brass objects instead. */
   XmlElementAttribute* attr = new XmlElementAttribute();
   attr->ElementName = S"Brass";
   attr->Type = __typeof(Brass);

   // Add the element to the collection of elements.
   attrs->XmlElements->Add(attr);

   // Create the XmlAttributeOverrides object.
   XmlAttributeOverrides* attrOverrides = new XmlAttributeOverrides();

   /* Add the type of the class that contains the overridden 
   member and the XmlAttributes to override it with to the 
   XmlAttributeOverrides object. */
   attrOverrides->Add(__typeof(Orchestra), S"Instruments", attrs);

   // Create the XmlSerializer using the XmlAttributeOverrides.
   XmlSerializer* s = 
      new XmlSerializer(__typeof(Orchestra), attrOverrides);

   // Writing the file requires a TextWriter.
   TextWriter* writer = new StreamWriter(filename);

   // Create the object that will be serialized.
   Orchestra* band = new Orchestra();

   // Create an object of the derived type.
   Brass* i = new Brass();
   i->Name = S"Trumpet";
   i->IsValved = true;
   Instrument* myInstruments[] = {i};
   band->Instruments = myInstruments;

   // Serialize the object.
   s->Serialize(writer,band);
   writer->Close();
}

void DeserializeObject(String* filename)
{
   XmlAttributeOverrides* attrOverrides = 
      new XmlAttributeOverrides();
   XmlAttributes* attrs = new XmlAttributes();

   // Create an XmlElementAttribute to override the Instrument.
   XmlElementAttribute* attr = new XmlElementAttribute();
   attr->ElementName = S"Brass";
   attr->Type = __typeof(Brass);

   // Add the XmlElementAttribute to the collection of objects.
   attrs->XmlElements->Add(attr);

   attrOverrides->Add(__typeof(Orchestra), S"Instruments", attrs);

   // Create the XmlSerializer using the XmlAttributeOverrides.
   XmlSerializer* s = 
      new XmlSerializer(__typeof(Orchestra), attrOverrides);

   FileStream* fs = new FileStream(filename, FileMode::Open);
   Orchestra* band = dynamic_cast<Orchestra*> (s->Deserialize(fs));
   Console::WriteLine(S"Brass:");

   /* The difference between deserializing the overridden 
   XML document and serializing it is this: To read the derived 
   object values, you must declare an object of the derived type 
   (Brass), and cast the Instrument instance to it. */
   Brass* b;
   System::Collections::IEnumerator* myEnum = band->Instruments->GetEnumerator();
   while (myEnum->MoveNext())
   {
      Instrument* i = __try_cast<Instrument*>(myEnum->Current);
      b = dynamic_cast<Brass*>(i);
      Console::WriteLine(S"{0}\n{1}", b->Name, __box(b->IsValved));
   }
}

int main()
{
   SerializeObject(S"Override.xml");
   DeserializeObject(S"Override.xml");
}

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。

必要条件

名前空間: System.Xml.Serialization

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System.Xml (System.Xml.dll 内)

参照

XmlAttributeOverrides メンバ | System.Xml.Serialization 名前空間 | Deserialize | Serialize | XmlSerializer | XML シリアル化の概要 | XML シリアル化のオーバーライド | XmlAttributes | 属性を使用した XML シリアル化の制御