XmlAttributes.XmlAttribute プロパティ

[アーティクル]
03/28/2008

XmlSerializer が、パブリックフィールドまたは読み書き可能なパブリックプロパティを XML 属性としてシリアル化する方法を指定するオブジェクトを取得または設定します。

Public Property XmlAttribute As XmlAttributeAttribute
[C#]
public XmlAttributeAttribute XmlAttribute {get; set;}
[C++]
public: __property XmlAttributeAttribute* get_XmlAttribute();public: __property void set_XmlAttribute(XmlAttributeAttribute*);
[JScript]
public function get XmlAttribute() : XmlAttributeAttribute;public function set XmlAttribute(XmlAttributeAttribute);

プロパティ値

パブリックフィールドまたは読み書き可能プロパティを XML 属性としてシリアル化する方法を制御する XmlAttributeAttribute 。

解説

既定では、パブリックフィールドまたは読み書き可能なパブリックプロパティに属性が適用されないと、パブリックフィールドまたは読み書き可能なパブリックプロパティが XML 要素としてシリアル化されます。また、フィールドまたはプロパティに XmlAttributeAttribute を適用することによって XML 属性を生成するように、 XmlSerializer に指示できます。 XmlAttribute プロパティによって、既定のシリアル化、およびメンバに XmlAttributeAttribute を適用することによって制御されているシリアル化をオーバーライドできます。これを行うには、 XmlAttributeAttribute を作成し、そのプロパティ (AttributeName など) を設定します。新しいオブジェクトを XmlAttributes オブジェクトの XmlAttribute プロパティに代入します。フィールドまたはプロパティを含むオブジェクトの型、およびフィールドまたはプロパティの名前を指定して、 XmlAttributes オブジェクトを XmlAttributeOverrides オブジェクトに追加します。最後に、 XmlAttributeOverrides オブジェクトを使用して XmlSerializer を作成し、 Serialize メソッドまたは Deserialize メソッドを呼び出します。

使用例

[Visual Basic, C#, C++] GroupName という名前のプロパティを含む Group という名前のクラスをシリアル化する例を次に示します。GroupName プロパティは、XML 属性としてシリアル化されています。この例では、 XmlAttributeOverrides オブジェクトと XmlAttributes オブジェクトを作成してフィールドの既定のシリアル化をオーバーライドします。この例では、次に XmlAttributeAttribute を作成して該当するプロパティを個別にオーバーライドし、オブジェクトを XmlAttribute プロパティに設定します。 XmlAttributes オブジェクトはオーバーライドされた指定メンバの名前で、 XmlAttributeOverrides オブジェクトに追加されます。最後に、 XmlAttributeOverrides オブジェクトを使用して XmlSerializer を構築し、返します。

 
Imports System
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization


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


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("OverrideAttribute.xml")
        test.DeserializeObject("OverrideAttribute.xml")
    End Sub
    
    ' Return an XmlSerializer used for overriding. 
    Public Function CreateOverrider() As XmlSerializer
        ' Create the XmlAttributeOverrides and XmlAttributes objects.
        Dim xOver As New XmlAttributeOverrides()
        Dim xAttrs As New XmlAttributes()
        
        ' Create an overriding XmlAttributeAttribute set it to
        ' the XmlAttribute property of the XmlAttributes object.
        Dim xAttribute As New XmlAttributeAttribute("SplinterName")
        xAttrs.XmlAttribute = xAttribute
        
        ' Add to the XmlAttributeOverrides. Specify the member name.
        xOver.Add(GetType(Group), "GroupName", xAttrs)
        
        ' Create the XmlSerializer and return it.
        Return New XmlSerializer(GetType(Group), xOver)
    End Function 'CreateOverrider
    
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an instance of the XmlSerializer class.
        Dim mySerializer As XmlSerializer = CreateOverrider()
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create an instance of the class that will be serialized.
        Dim myGroup As New Group()
        
        ' Set the Name property, which will be generated
        ' as an XML attribute. 
        myGroup.GroupName = ".NET"
        myGroup.GroupNumber = 1
        ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup)
        writer.Close()
    End Sub
    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim mySerializer As XmlSerializer = CreateOverrider()
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim myGroup As Group = CType(mySerializer.Deserialize(fs), Group)

        Console.WriteLine(myGroup.GroupName)
        Console.WriteLine(myGroup.GroupNumber)
    End Sub
End Class


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

// This is the class that will be serialized.
public class Group
{
   // This is the attribute that will be overridden.
   [XmlAttribute]
   public string GroupName;
   public int GroupNumber;
}
 
public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("OverrideAttribute.xml");
      test.DeserializeObject("OverrideAttribute.xml");
   }
   // Return an XmlSerializer used for overriding. 
   public XmlSerializer CreateOverrider()
   {
      // Create the XmlAttributeOverrides and XmlAttributes objects.
      XmlAttributeOverrides xOver = new XmlAttributeOverrides();
      XmlAttributes xAttrs = new XmlAttributes();

      /* Create an overriding XmlAttributeAttribute set it to 
      the XmlAttribute property of the XmlAttributes object.*/
      XmlAttributeAttribute xAttribute = new XmlAttributeAttribute("SplinterName");
      xAttrs.XmlAttribute = xAttribute;

      // Add to the XmlAttributeOverrides. Specify the member name.
      xOver.Add(typeof(Group), "GroupName", xAttrs);

      // Create the XmlSerializer and return it.
      return new XmlSerializer(typeof(Group), xOver);
   }
 
   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =  CreateOverrider();
      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      /* Set the Name property, which will be generated 
      as an XML attribute. */
      myGroup.GroupName = ".NET";
      myGroup.GroupNumber = 1;
      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
       writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlSerializer mySerializer = CreateOverrider();
      FileStream fs = new FileStream(filename, FileMode.Open);
      Group myGroup = (Group) 
      mySerializer.Deserialize(fs);
      
      Console.WriteLine(myGroup.GroupName);
      Console.WriteLine(myGroup.GroupNumber);
   }
}
   

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

// This is the class that will be serialized.
public __gc class Group
{
   // This is the attribute that will be overridden.
public:
   [XmlAttributeAttribute]
   String* GroupName;
   int GroupNumber;
};

// Return an XmlSerializer used for overriding. 
XmlSerializer* CreateOverrider()
{
   // Create the XmlAttributeOverrides and XmlAttributes objects.
   XmlAttributeOverrides* xOver = new XmlAttributeOverrides();
   XmlAttributes* xAttrs = new XmlAttributes();

   /* Create an overriding XmlAttributeAttribute set it to 
   the XmlAttribute property of the XmlAttributes object.*/
   XmlAttributeAttribute* xAttribute = new XmlAttributeAttribute(S"SplinterName");
   xAttrs->XmlAttribute = xAttribute;

   // Add to the XmlAttributeOverrides. Specify the member name.
   xOver->Add(__typeof(Group), S"GroupName", xAttrs);

   // Create the XmlSerializer and return it.
   return new XmlSerializer(__typeof(Group), xOver);
}

void SerializeObject(String* filename)
{
   // Create an instance of the XmlSerializer class.
   XmlSerializer* mySerializer =  CreateOverrider();
   // Writing the file requires a TextWriter.
   TextWriter* writer = new StreamWriter(filename);

   // Create an instance of the class that will be serialized.
   Group* myGroup = new Group();

   /* Set the Name property, which will be generated 
   as an XML attribute. */
   myGroup->GroupName = S".NET";
   myGroup->GroupNumber = 1;
   // Serialize the class, and close the TextWriter.
   mySerializer->Serialize(writer, myGroup);
   writer->Close();
}

void DeserializeObject(String* filename)
{
   XmlSerializer* mySerializer = CreateOverrider();
   FileStream* fs = new FileStream(filename, FileMode::Open);
   Group* myGroup = dynamic_cast<Group*>(mySerializer->Deserialize(fs));

   Console::WriteLine(myGroup->GroupName);
   Console::WriteLine(myGroup->GroupNumber);
}

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

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

必要条件

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

参照

XmlAttributes クラス | XmlAttributes メンバ | System.Xml.Serialization 名前空間

次の方法で共有

XmlAttributes.XmlAttribute プロパティ

プロパティ値

解説

使用例

必要条件

参照

その他のリソース