XmlTextAttribute クラス

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

XmlTextAttribute クラス

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

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field
 Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue)>
 _
Public Class XmlTextAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As XmlTextAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)]
 
public class XmlTextAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property|AttributeTargets::Field|AttributeTargets::Parameter|AttributeTargets::ReturnValue)]
 
public ref class XmlTextAttribute : public
 Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)
 */ 
public class XmlTextAttribute extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)
 
public class XmlTextAttribute extends
 Attribute

解説

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 という短い語を使用できます。

使用例

Visual Basic

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 <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::Xml::Serialization;
using namespace System::IO;

public ref class Group1
{
public:

   // The XmlTextAttribute with type set to string informs the 
   // XmlSerializer that strings should be serialized as XML text.

   [XmlText(String::typeid)]
   [XmlElement(Int32::typeid)]
   [XmlElement(Double::typeid)]
   array<Object^>^All;
   Group1()
   {
      array<Object^>^temp = {321,"One",2,3.0,"Two"};
      All = temp;
   }
};

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

public ref class Group2
{
public:

   [XmlText(Type=GroupType::typeid)]
   GroupType Type;
};

public ref class Group3
{
public:

   [XmlText(Type=DateTime::typeid)]
   DateTime CreationTime;
   Group3()
   {
      CreationTime = DateTime::Now;
   }
};

public ref class Test
{
public:
   static void main()
   {
      Test^ t = gcnew Test;
      t->SerializeArray( "XmlText1.xml" );
      t->SerializeEnum( "XmlText2.xml" );
      t->SerializeDateTime( "XmlText3.xml" );
   }

private:
   void SerializeArray( String^ filename )
   {
      XmlSerializer^ ser = gcnew XmlSerializer( Group1::typeid );
      Group1^ myGroup1 = gcnew Group1;
      TextWriter^ writer = gcnew StreamWriter( filename );
      ser->Serialize( writer, myGroup1 );
      writer->Close();
   }

   void SerializeEnum( String^ filename )
   {
      XmlSerializer^ ser = gcnew XmlSerializer( Group2::typeid );
      Group2^ myGroup = gcnew Group2;
      myGroup->Type = GroupType::Medium;
      TextWriter^ writer = gcnew StreamWriter( filename );
      ser->Serialize( writer, myGroup );
      writer->Close();
   }

   void SerializeDateTime( String^ filename )
   {
      XmlSerializer^ ser = gcnew XmlSerializer( Group3::typeid );
      Group3^ myGroup = gcnew Group3;
      TextWriter^ writer = gcnew StreamWriter( filename );
      ser->Serialize( writer, myGroup );
      writer->Close();
   }
};

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

J#

import System.*;
import System.Xml.Serialization.*;
import System.IO.*;

public class Group1
{
    // The XmlTextAttribute with type set to string informs the 
    // XmlSerializer that strings should be serialized as XML text.
    /** @attribute XmlText(String.class)
     */
    /** @attribute XmlElement(int.class)
     */
    /** @attribute XmlElement(double.class)
     */
    public Object all[] = new Object[] { (Int32)321,
 "One", (Int32)2,
        (System.Double)3.0, "Two" };
} //Group1

public class Group2
{
    /** @attribute XmlElement(GroupType.class, ElementName = "GroupType")
     */
    public GroupType type;
} //Group2

public class GroupType
{
    private int member;
    GroupType()
    {
        member = 0;
    } //GroupType

    GroupType(int n)
    {
        member = n;
    } //GroupType

    public static int small;
    public static int medium;
    public static int large;
} //GroupType

public class Group3
{
    /** @attribute XmlText(Type = DateTime.class)
     */
    public DateTime creationTime = DateTime.get_Now();
} //Group3

public class Test
{
    public static void main(String[]
 args)
    {
        Test t = new Test();
        t.SerializeArray("XmlText1.xml");
        t.SerializeEnum("XmlText2.xml");
        t.SerializeDateTime("XmlText3.xml");
    } //main

    private void SerializeArray(String fileName)
    {
        XmlSerializer ser = new XmlSerializer(Group1.class.ToType());
        Group1 myGroup1 = new Group1();
        TextWriter writer = new StreamWriter(fileName);
        ser.Serialize(writer, myGroup1);
        writer.Close();
    } //SerializeArray

    private void SerializeEnum(String fileName)
    {
        XmlSerializer ser = new XmlSerializer(Group2.class.ToType());
        Group2 myGroup = new Group2();
        myGroup.type = new GroupType(GroupType.medium);
        TextWriter writer = new StreamWriter(fileName);
        ser.Serialize(writer, myGroup);
        writer.Close();
    } //SerializeEnum

    private void SerializeDateTime(String fileName)
    {
        XmlSerializer ser = new XmlSerializer(Group3.class.ToType());
        Group3 myGroup = new Group3();
        TextWriter writer = new StreamWriter(fileName);
        ser.Serialize(writer, myGroup);
        writer.Close();
    } //SerializeDateTime
} //Test

継承階層

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

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
XmlTextAttribute メンバ
System.Xml.Serialization 名前空間
XmlAttributeOverrides クラス
XmlAttributes クラス
XmlSerializer クラス
XmlAttributes.XmlText プロパティ
XmlAttributes クラス
その他の技術情報
XML シリアル化の概要
方法 : XML ストリームの代替要素名を指定する
属性を使用した XML シリアル化の制御
XML シリアル化の例
XML スキーマ定義ツール (Xsd.exe)