XmlAttributeOverrides.Add メソッド

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

public:
 void Add(Type ^ type, System::Xml::Serialization::XmlAttributes ^ attributes);

public void Add(Type type, System.Xml.Serialization.XmlAttributes attributes);

member this.Add : Type * System.Xml.Serialization.XmlAttributes -> unit

Public Sub Add (type As Type, attributes As XmlAttributes)

パラメーター

例

次の例では、 Band という名前のクラスをシリアル化します。このクラスは、 Orchestra という名前のクラスから派生します。 この例では、XmlRootAttribute オブジェクトを作成し、XmlAttributes オブジェクトのXmlRoot プロパティに割り当てます。 次に、 Add メソッドを呼び出して、 XmlAttributes オブジェクトを XmlAttributeOverrides オブジェクトに追加します。

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

/* This is the class that will be overridden. The XmlIncludeAttribute
tells the XmlSerializer that the overriding type exists. */

[XmlInclude(typeof(Band))]
public class Orchestra
{
   public Instrument[] Instruments;
}

// This is the overriding class.
public class Band:Orchestra
{
   public string BandName;
}

public class Instrument
{
   public string Name;
}

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 object that is being overridden requires
      an XmlAttributes object. */
      XmlAttributes attrs = new XmlAttributes();

      // An XmlRootAttribute allows overriding the Orchestra class.
      XmlRootAttribute xmlRoot = new XmlRootAttribute();

      // Set the object to the XmlAttribute.XmlRoot property.
      attrs.XmlRoot = xmlRoot;

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

      // Add the XmlAttributes to the XmlAttributeOverrrides.
      attrOverrides.Add(typeof(Orchestra), 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 using the derived class.
      Band band = new Band();
      band.BandName = "NewBand";

      // Create an Instrument.
      Instrument i = new Instrument();
      i.Name = "Trumpet";
      Instrument[] myInstruments = {i};
      band.Instruments = myInstruments;

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

   public void DeserializeObject(string filename)
   {
      XmlAttributes attrs = new XmlAttributes();
      XmlRootAttribute attr = new XmlRootAttribute();
      attrs.XmlRoot = attr;
      XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();

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

      XmlSerializer s =
      new XmlSerializer(typeof(Orchestra), attrOverrides);

      FileStream fs = new FileStream(filename, FileMode.Open);

      // Deserialize the Band object.
      Band band = (Band) s.Deserialize(fs);
      Console.WriteLine("Brass:");

      foreach(Instrument i in band.Instruments)
      {
         Console.WriteLine(i.Name);
      }
   }
}

Option Explicit
Option Strict

Imports System.IO
Imports System.Xml.Serialization


' This is the class that will be overridden. The XmlIncludeAttribute
' tells the XmlSerializer that the overriding type exists. 
<XmlInclude(GetType(Band))> _
Public Class Orchestra
    Public Instruments() As Instrument
End Class

' This is the overriding class.
Public Class Band
    Inherits Orchestra
    Public BandName As String
End Class

Public Class Instrument
    Public Name As String
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 object that is being overridden requires
        ' an XmlAttributes object. 
        Dim attrs As New XmlAttributes()
        
        ' An XmlRootAttribute allows overriding the Orchestra class.
        Dim xmlRoot As New XmlRootAttribute()
        
        ' Set the object to the XmlAttribute.XmlRoot property.
        attrs.XmlRoot = xmlRoot
        
        ' Create an XmlAttributeOverrides object.
        Dim attrOverrides As New XmlAttributeOverrides()
        
        ' Add the XmlAttributes to the XmlAttributeOverrrides.
        attrOverrides.Add(GetType(Orchestra), 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 using the derived class.
        Dim band As New Band()
        band.BandName = "NewBand"
        
        ' Create an Instrument.
        Dim i As New Instrument()
        i.Name = "Trumpet"
        Dim myInstruments() As Instrument = {i}
        band.Instruments = myInstruments
        
        ' Serialize the object.
        s.Serialize(writer, band)
        writer.Close()
    End Sub    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim attrs As New XmlAttributes()
        Dim attr As New XmlRootAttribute()
        attrs.XmlRoot = attr
        Dim attrOverrides As New XmlAttributeOverrides()
        
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
        
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
        
        Dim fs As New FileStream(filename, FileMode.Open)
        
        ' Deserialize the Band object.
        Dim band As Band = CType(s.Deserialize(fs), Band)
        Console.WriteLine("Brass:")
        
        Dim i As Instrument
        For Each i In  band.Instruments
            Console.WriteLine(i.Name)
        Next i
    End Sub
End Class

注釈

XmlAttributes オブジェクトには、XmlSerializerが一連のオブジェクトの既定のシリアル化動作をオーバーライドする属性オブジェクトの和集合が含まれています。 オーバーライドする特定の動作に応じて、 XmlAttributes オブジェクトに配置する属性オブジェクトを選択します。 たとえば、 XmlSerializer では、クラス メンバーが既定で XML 要素としてシリアル化されます。 メンバーを XM 属性としてシリアル化する場合は、XmlAttributeAttributeを作成し、XmlAttributesのXmlAttribute プロパティに割り当てて、XmlAttributes オブジェクトをXmlAttributeOverrides オブジェクトに追加します。

このオーバーロードを使用して、 XmlRootAttribute または XmlTypeAttributeをオーバーライドします。

こちらもご覧ください

• XmlAttributes
• XmlSerializer

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

ソース:

XmlAttributeOverrides.cs

public:
 void Add(Type ^ type, System::String ^ member, System::Xml::Serialization::XmlAttributes ^ attributes);

public void Add(Type type, string member, System.Xml.Serialization.XmlAttributes attributes);

public void Add(Type type, string member, System.Xml.Serialization.XmlAttributes? attributes);

member this.Add : Type * string * System.Xml.Serialization.XmlAttributes -> unit

Public Sub Add (type As Type, member As String, attributes As XmlAttributes)

パラメーター

例

次の例では、XmlAttributeAttribute オブジェクトを作成し、XmlAttributes オブジェクトのXmlAttribute プロパティに割り当てます。 次に、 XmlAttributes オブジェクトを XmlAttributeOverrides オブジェクトに追加してから、 XmlSerializerを作成します。

// This is the class that will be serialized.
public class Group
{
   public string GroupName;
   [XmlAttribute]
   public int GroupCode;
}

public class Sample
{
public XmlSerializer CreateOverrider()
{
   // Create an XmlAttributeOverrides object.
   XmlAttributeOverrides xOver = new XmlAttributeOverrides();

   /* Create an XmlAttributeAttribute to override the base class
   object's XmlAttributeAttribute object. Give the overriding object
   a new attribute name ("Code"). */
   XmlAttributeAttribute xAtt = new XmlAttributeAttribute();
   xAtt.AttributeName = "Code";

   /* Create an instance of the XmlAttributes class and set the
   XmlAttribute property to the XmlAttributeAttribute object. */
   XmlAttributes attrs = new XmlAttributes();
   attrs.XmlAttribute = xAtt;

   /* Add the XmlAttributes object to the XmlAttributeOverrides
      and specify the type and member name to override. */
   xOver.Add(typeof(Group), "GroupCode", attrs);

   XmlSerializer xSer = new XmlSerializer(typeof(Group), xOver);
   return xSer;
}
}

' This is the class that will be serialized.
Public Class Group
    Public GroupName As String
    <XmlAttribute()> Public GroupCode As Integer
End Class

Public Class Sample
    
    Public Function CreateOverrider() As XmlSerializer
        ' Create an XmlAttributeOverrides object. 
        Dim xOver As New XmlAttributeOverrides()
        
        ' Create an XmlAttributeAttribute to override the base class
        ' object's XmlAttributeAttribute object. Give the overriding object
        ' a new attribute name ("Code").
        Dim xAtt As New XmlAttributeAttribute()
        xAtt.AttributeName = "Code"
        
        ' Create an instance of the XmlAttributes class and set the
        ' XmlAttribute property to the XmlAttributeAttribute object. 
        Dim attrs As New XmlAttributes()
        attrs.XmlAttribute = xAtt
        
        ' Add the XmlAttributes object to the XmlAttributeOverrides
        ' and specify the type and member name to override. 
        xOver.Add(GetType(Group), "GroupCode", attrs)
        
        Dim xSer As New XmlSerializer(GetType(Group), xOver)
        Return xSer
    End Function
End Class

注釈

XmlAttributes オブジェクトには、XmlSerializerが一連のオブジェクトの既定のシリアル化動作をオーバーライドする属性オブジェクトの和集合が含まれています。 オーバーライドする特定の動作に応じて、 XmlAttributes オブジェクトに配置する属性オブジェクトを選択します。 たとえば、 XmlSerializer では、クラス メンバーが既定で XML 要素としてシリアル化されます。 代わりにメンバーを XML 属性としてシリアル化する場合は、XmlAttributeAttributeを作成し、それをXmlAttributesのXmlAttribute プロパティに割り当てて、XmlAttributeOverrides オブジェクトにXmlAttributes オブジェクトを追加します。

このメソッドは、 XmlElementAttribute、 XmlAttributeAttribute、 XmlArrayAttribute、 XmlArrayItemAttribute、または XmlIgnoreAttributeをオーバーライドする場合に使用します。

こちらもご覧ください

• XmlAttributes
• XmlSerializer