XmlTextAttribute クラス

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

XmlSerializer が、クラスをシリアル化化または逆シリアル化するときに、そのクラスに含まれる特定のメンバを XML テキストとして処理することを指定します。

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

System.Object
System.Attribute
System.Xml.Serialization.XmlTextAttribute

<AttributeUsage(AttributeTargets.Property Or AttributeTargets.Field _
   Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue)>
Public Class XmlTextAttribute   Inherits Attribute
[C#]
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field
   | AttributeTargets.Parameter | AttributeTargets.ReturnValue)]
public class XmlTextAttribute : Attribute
[C++]
[AttributeUsage(AttributeTargets::Property |
   AttributeTargets::Field | AttributeTargets::Parameter |
   AttributeTargets::ReturnValue)]
public __gc class XmlTextAttribute : public Attribute
[JScript]
public
   AttributeUsage(AttributeTargets.Property | AttributeTargets.Field |
   AttributeTargets.Parameter | AttributeTargets.ReturnValue)
class XmlTextAttribute extends Attribute

スレッドセーフ

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

解説

XmlTextAttribute は、 XmlSerializer がオブジェクトを Serialize メソッドおよび Deserialize メソッドを使用してシリアル化する方法を制御する一連の属性のうちの 1 つです。類似する属性の完全な一覧については、「 XML シリアル化を制御する属性」を参照してください。

1 つのクラスに適用できるのは、 XmlTextAttribute クラスの 1 つのインスタンスだけです。

XmlTextAttribute は、パブリックフィールドおよびパブリックな読み書き可能プロパティに適用できます。

文字列の配列を返すフィールドまたはプロパティには、 XmlTextAttribute を適用できます。この属性は Object 型の配列にも適用できますが、 Type プロパティを文字列型に設定する必要があります。この場合は、この配列に挿入された任意の文字列が XML テキストとしてシリアル化されます。

XmlTextAttribute は、 XmlNode を返すフィールドや、 XmlNode オブジェクトの配列を返すフィールドにも適用できます。

既定では、 XmlSerializer はクラスメンバを XML 要素としてシリアル化します。ただし、 XmlTextAttribute をメンバに適用すると、 XmlSerializer はそのメンバの値を XML テキストに変換します。つまり、値はエンコードされて XML 要素の内容となります。

XML スキーマ定義ツール (Xsd.exe) は、XML スキーマ定義 (XSD: XML Schema Definition) ファイル (.xsd) からクラスを作成するときに、 XmlTextAttribute を生成することがあります。これが生成されるのは、混合コンテンツを含む complexType がスキーマに含まれている場合です。この場合は、対応するクラスにも文字列配列を返すメンバが含まれることになり、そのメンバには XmlTextAttribute が適用されます。たとえば、 Xml Schema Definition ツールが次のスキーマを処理するとします。

<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="" 
xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="LinkList" type="LinkList" />
  <xs:complexType name="LinkList" mixed="true">
    <xs:sequence>
      <xs:element minOccurs="1" maxOccurs="1" name="id" type="xs:int" />
      <xs:element minOccurs="0" maxOccurs="1" name="name" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="next" type="LinkList" />
    </xs:sequence>
  </xs:complexType>
</xs:schema>

この場合、次のクラスが生成されます。

' Visual Basic code
Public Class LinkList 
   Public id As Integer
   Public string name
   Public LinkList next
   <System.Xml.Serialization.XmlTextAttribute()> _
   Public Text() As string
End Class
// C# code
public class LinkList {
   public int id;
   public string name;
   public LinkList next;
   [System.Xml.Serialization.XmlTextAttribute()]
   public string[] Text;
}

属性の使用方法については、「属性を使用したメタデータの拡張」を参照してください。

メモコードでは、 XmlTextAttribute の代わりに XmlText という短い語を使用できます。

使用例

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


Public Class Group1
   ' The XmlTextAttribute with type set to String informs the 
   ' XmlSerializer that strings should be serialized as XML text.
   <XmlText(GetType(String)), _
   XmlElement(GetType(integer)), _  
   XmlElement(GetType(double))> _
   public All () As Object = _
   New Object (){321, "One", 2, 3.0, "Two" }
End Class


Public Class Group2
   <XmlText(GetType(GroupType))> _
   public Type As GroupType 
End Class

Public Enum GroupType
   Small
   Medium
   Large
End Enum

Public Class Group3
   <XmlText(GetType(DateTime))> _
   Public CreationTime As DateTime = DateTime.Now
End Class

Public Class Test
   Shared Sub Main()
      Dim t As Test = New Test()
      t.SerializeArray("XmlText1.xml")
      t.SerializeEnum("XmlText2.xml")
      t.SerializeDateTime("XmlText3.xml")
   End Sub

   Private Sub SerializeArray(filename As String)
      Dim ser As XmlSerializer = New XmlSerializer(GetType(Group1))
      Dim myGroup1 As Group1 = New Group1()

      Dim writer As TextWriter = New StreamWriter(filename)

      ser.Serialize(writer, myGroup1)
      writer.Close()
   End Sub

   Private Sub SerializeEnum(filename As String)
      Dim ser As XmlSerializer = New XmlSerializer(GetType(Group2))
      Dim myGroup As Group2 = New Group2()
      myGroup.Type = GroupType.Medium
      Dim writer As TextWriter = New StreamWriter(filename)

      ser.Serialize(writer, myGroup)
      writer.Close()
   End Sub

   Private Sub SerializeDateTime(filename As String)
      Dim ser As XmlSerializer = new XmlSerializer(GetType(Group3))
      Dim myGroup As Group3 = new Group3()
      Dim writer As TextWriter = new StreamWriter(filename)

      ser.Serialize(writer, myGroup)
      writer.Close()
   End Sub
End Class

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


public class Group1{
   // The XmlTextAttribute with type set to string informs the 
   // XmlSerializer that strings should be serialized as XML text.
   [XmlText(typeof(string))]
   [XmlElement(typeof(int))]  
   [XmlElement(typeof(double))]
   public object [] All= new object []{321, "One", 2, 3.0, "Two" };
}

public class Group2{
   [XmlText(Type = typeof(GroupType))]
   public GroupType Type;
}
public enum GroupType{
   Small,
   Medium,
   Large
}

public class Group3{
   [XmlText(Type=typeof(DateTime))]
   public DateTime CreationTime = DateTime.Now;
}

public class Test{
   static void Main(){
      Test t = new Test();
      t.SerializeArray("XmlText1.xml");
      t.SerializeEnum("XmlText2.xml");
      t.SerializeDateTime("XmlText3.xml");
   }

   private void SerializeArray(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Group1));
      Group1 myGroup1 = new Group1();

      TextWriter writer = new StreamWriter(filename);

      ser.Serialize(writer, myGroup1);
      writer.Close();
   }

   private void SerializeEnum(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Group2));
      Group2 myGroup = new Group2();
      myGroup.Type = GroupType.Medium;
      TextWriter writer = new StreamWriter(filename);

      ser.Serialize(writer, myGroup);
      writer.Close();
   }

   private void SerializeDateTime(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Group3));
      Group3 myGroup = new Group3();
      TextWriter writer = new StreamWriter(filename);

      ser.Serialize(writer, myGroup);
      writer.Close();
   }   
}

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


public __gc class Group1{
   // The XmlTextAttribute with type set to string informs the 
   // XmlSerializer that strings should be serialized as XML text.
public:
   [XmlText(__typeof(String))]
   [XmlElement(__typeof(Int32))]  
   [XmlElement(__typeof(Double))]
   Object* All[];
   Group1(){
      Object* temp[]= {__box(321), S"One", __box(2), __box(3.0), S"Two" };
      All = temp;
   }
};

public __value enum GroupType{
   Small,
   Medium,
   Large
};

public __gc class Group2{
public:
   [XmlText(Type = __typeof(GroupType))]
   GroupType Type;
};

public __gc class Group3{
public:
   [XmlText(Type=__typeof(DateTime))]
   DateTime CreationTime;
   Group3(){
      CreationTime = DateTime::Now;
   }
};

public __gc class Test{
public:
   static void main(){
      Test* t = new Test();
      t->SerializeArray(S"XmlText1.xml");
      t->SerializeEnum(S"XmlText2.xml");
      t->SerializeDateTime(S"XmlText3.xml");
   }

private:
   void SerializeArray(String* filename){
      XmlSerializer* ser = new XmlSerializer(__typeof(Group1));
      Group1* myGroup1 = new Group1();

      TextWriter* writer = new StreamWriter(filename);

      ser->Serialize(writer, myGroup1);
      writer->Close();
   }

   void SerializeEnum(String* filename){
      XmlSerializer* ser = new XmlSerializer(__typeof(Group2));
      Group2* myGroup = new Group2();
      myGroup->Type = GroupType::Medium;
      TextWriter* writer = new StreamWriter(filename);

      ser->Serialize(writer, myGroup);
      writer->Close();
   }

   void SerializeDateTime(String* filename){
      XmlSerializer* ser = new XmlSerializer(__typeof(Group3));
      Group3* myGroup = new Group3();
      TextWriter* writer = new StreamWriter(filename);

      ser->Serialize(writer, myGroup);
      writer->Close();
   }   
};

int main()
{
   Test::main();
}

[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 ファミリ, .NET Compact Framework - Windows CE .NET

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

参照

次の方法で共有

XmlTextAttribute クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース