XmlElementAttribute クラス
パブリック フィールドやパブリック プロパティを保持するオブジェクトを XmlSerializer がシリアル化または逆シリアル化するときに、それらのフィールドやプロパティが XML 要素を表すかどうかを示します。
この型のすべてのメンバの一覧については、XmlElementAttribute メンバ を参照してください。
System.Object
System.Attribute
System.Xml.Serialization.XmlElementAttribute
<AttributeUsage(AttributeTargets.Property Or AttributeTargets.Field _
Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue)>
Public Class XmlElementAttribute Inherits Attribute
[C#]
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field
| AttributeTargets.Parameter | AttributeTargets.ReturnValue)]
public class XmlElementAttribute : Attribute
[C++]
[AttributeUsage(AttributeTargets::Property |
AttributeTargets::Field | AttributeTargets::Parameter |
AttributeTargets::ReturnValue)]
public __gc class XmlElementAttribute : public Attribute
[JScript]
public
AttributeUsage(AttributeTargets.Property | AttributeTargets.Field |
AttributeTargets.Parameter | AttributeTargets.ReturnValue)
class XmlElementAttribute extends Attribute
スレッドセーフ
この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。
解説
XmlElementAttribute は、 XmlSerializer がオブジェクトをシリアル化または逆シリアル化する方法を制御する一連の属性のうちの 1 つです。類似する属性の完全な一覧については、「 XML シリアル化を制御する属性 」を参照してください。
通常、XML ドキュメントには XML 要素が含まれており、各 XML 要素は、開始タグ、終了タグ、タグ間のデータという 3 つの部分で構成されています。XML タグは入れ子にできます。つまり、タグ間のデータが XML 要素になっている場合もあります。これにより、ある要素で別の要素を囲むことができるため、ドキュメントにデータを階層的に格納できます。XML 要素には、属性を含むこともできます。
要素名や名前空間など、XML 要素の特性を制御するには、 XmlElementAttribute をパブリック フィールドまたは読み取り/書き込み可能なパブリック プロパティに適用します。
XmlElementAttribute は、オブジェクトの配列を返すフィールドには何回でも適用できます。その理由は、その配列に挿入できる各種の型を、 Type プロパティを使用して指定できるようにするためです。たとえば、下の C# コードの配列には、文字列と整数の両方を格納できます。
public class Things{
[XmlElement(DataType = typeof(string)),
XmlElement(DataType = typeof(int))]
public object[] StringsAndInts;
}
結果として、次のような XML が生成されます。
<Things>
<string>Hello</string>
<int>999</int>
<string>World</string>
</Things>
ElementName プロパティの値を指定せずに XmlElementAttribute を何回も適用した場合、各要素には、配列に挿入できるオブジェクトの型の名前が付けられます。
配列を返すフィールドまたはプロパティに XmlElementAttribute を適用すると、その配列内の項目は XML 要素のシーケンスとしてエンコードされます。
これに対し、このようなフィールドまたはプロパティに XmlElementAttribute を適用しないと、それらが返す配列内の項目は単なる要素のシーケンスとしてエンコードされ、それぞれフィールドまたはプロパティの名前が付いた要素として入れ子になります。配列のシリアル化方法を制御する場合は、 XmlArrayAttribute 属性と XmlArrayItemAttribute 属性を使用します。
Type プロパティを設定して、元のフィールドまたはプロパティ (XmlElementAttribute を適用したフィールドまたはプロパティ) の型から派生する型を指定できます。
フィールドまたはプロパティが ArrayList を返す場合は、そのメンバに XmlElementAttribute の複数のインスタンスを適用できます。各インスタンスの Type プロパティに、配列に挿入できるオブジェクトの型を設定します。
属性の使用方法については、「 属性を使用したメタデータの拡張 」を参照してください。
メモ コードでは、 XmlElementAttribute の代わりに XmlElement という短い語を使用できます。
使用例
[Visual Basic, C#, C++] Group という名前のクラスをシリアル化し、そのメンバのいくつかに XmlElementAttribute を適用する例を次に示します。 Employees という名前のフィールドは、 Employee オブジェクトの配列を返します。この例では、 XmlElementAttribute は、結果として生成される XML を入れ子にしないように指定しています。これは、配列内の項目の既定の状態です。
Imports System
Imports System.Collections
Imports System.IO
Imports System.Xml.Serialization
Public Class Group
' Set the element name and namespace of the XML element.
<XmlElement(ElementName := "Members", _
Namespace := "http://www.cpandl.com")> _
Public Employees() As Employee
<XmlElement(DataType := "double", _
ElementName := "Building")> _
Public GroupID As Double
<XmlElement(DataType := "hexBinary")> _
Public HexBytes() As Byte
<XmlElement(DataType := "boolean")> _
Public IsActive As Boolean
<XmlElement(GetType(Manager))> _
Public Manager As Employee
<XmlElement(GetType(Integer), _
ElementName := "ObjectNumber"), _
XmlElement(GetType(String), _
ElementName := "ObjectString")> _
Public ExtraInfo As ArrayList
End Class
Public Class Employee
Public Name As String
End Class
Public Class Manager
Inherits Employee
Public Level As Integer
End Class
Public Class Run
Public Shared Sub Main()
Dim test As New Run()
test.SerializeObject("FirstDoc.xml")
test.DeserializeObject("FirstDoc.xml")
End Sub
Public Sub SerializeObject(filename As String)
' Create the XmlSerializer.
Dim s As New XmlSerializer(GetType(Group))
' To write the file, a TextWriter is required.
Dim writer As New StreamWriter(filename)
' Create an instance of the group to serialize, and set
' its properties.
Dim group As New Group()
group.GroupID = 10.089f
group.IsActive = False
group.HexBytes = New Byte() {Convert.ToByte(100)}
Dim x As New Employee()
Dim y As New Employee()
x.Name = "Jack"
y.Name = "Jill"
group.Employees = New Employee() {x, y}
Dim mgr As New Manager()
mgr.Name = "Sara"
mgr.Level = 4
group.Manager = mgr
' Add a number and a string to the
' ArrayList returned by the ExtraInfo property.
group.ExtraInfo = New ArrayList()
group.ExtraInfo.Add(42)
group.ExtraInfo.Add("Answer")
' Serialize the object, and close the TextWriter.
s.Serialize(writer, group)
writer.Close()
End Sub
Public Sub DeserializeObject(filename As String)
Dim fs As New FileStream(filename, FileMode.Open)
Dim x As New XmlSerializer(GetType(Group))
Dim g As Group = CType(x.Deserialize(fs), Group)
Console.WriteLine(g.Manager.Name)
Console.WriteLine(g.GroupID)
Console.WriteLine(g.HexBytes(0))
Dim e As Employee
For Each e In g.Employees
Console.WriteLine(e.Name)
Next e
End Sub
End Class
[C#]
using System;
using System.Collections;
using System.IO;
using System.Xml.Serialization;
public class Group
{
/* Set the element name and namespace of the XML element.
By applying an XmlElementAttribute to an array, you instruct
the XmlSerializer to serialize the array as a series of XML
elements, instead of a nested set of elements. */
[XmlElement(
ElementName = "Members",
Namespace = "http://www.cpandl.com")]
public Employee[] Employees;
[XmlElement(DataType = "double",
ElementName = "Building")]
public double GroupID;
[XmlElement(DataType = "hexBinary")]
public byte [] HexBytes;
[XmlElement(DataType = "boolean")]
public bool IsActive;
[XmlElement(Type = typeof(Manager))]
public Employee Manager;
[XmlElement(typeof(int),
ElementName = "ObjectNumber"),
XmlElement(typeof(string),
ElementName = "ObjectString")]
public ArrayList ExtraInfo;
}
public class Employee
{
public string Name;
}
public class Manager:Employee{
public int Level;
}
public class Run
{
public static void Main()
{
Run test = new Run();
test.SerializeObject("FirstDoc.xml");
test.DeserializeObject("FirstDoc.xml");
}
public void SerializeObject(string filename)
{
// Create the XmlSerializer.
XmlSerializer s = new XmlSerializer(typeof(Group));
// To write the file, a TextWriter is required.
TextWriter writer = new StreamWriter(filename);
/* Create an instance of the group to serialize, and set
its properties. */
Group group = new Group();
group.GroupID = 10.089f;
group.IsActive = false;
group.HexBytes = new byte[1]{Convert.ToByte(100)};
Employee x = new Employee();
Employee y = new Employee();
x.Name = "Jack";
y.Name = "Jill";
group.Employees = new Employee[2]{x,y};
Manager mgr = new Manager();
mgr.Name = "Sara";
mgr.Level = 4;
group.Manager = mgr;
/* Add a number and a string to the
ArrayList returned by the ExtraInfo property. */
group.ExtraInfo = new ArrayList();
group.ExtraInfo.Add(42);
group.ExtraInfo.Add("Answer");
// Serialize the object, and close the TextWriter.
s.Serialize(writer, group);
writer.Close();
}
public void DeserializeObject(string filename)
{
FileStream fs = new FileStream(filename, FileMode.Open);
XmlSerializer x = new XmlSerializer(typeof(Group));
Group g = (Group) x.Deserialize(fs);
Console.WriteLine(g.Manager.Name);
Console.WriteLine(g.GroupID);
Console.WriteLine(g.HexBytes[0]);
foreach(Employee e in g.Employees)
{
Console.WriteLine(e.Name);
}
}
}
[C++]
#using <mscorlib.dll>
#using <System.Xml.dll>
#using <System.dll>
using namespace System;
using namespace System::Collections;
using namespace System::IO;
using namespace System::Xml::Serialization;
public __gc class Employee
{
public:
String* Name;
};
public __gc class Manager: public Employee{
public:
int Level;
};
public __gc class Group
{
public:
/* Set the element name and namespace of the XML element.
By applying an XmlElementAttribute to an array, you instruct
the XmlSerializer to serialize the array as a series of XML
elements, instead of a nested set of elements. */
[XmlElement(
ElementName = S"Members",
Namespace = S"http://www.cpandl.com")]
Employee* Employees[];
[XmlElement(DataType = S"double",
ElementName = S"Building")]
double GroupID;
[XmlElement(DataType = S"hexBinary")]
Byte HexBytes[];
[XmlElement(DataType = S"boolean")]
bool IsActive;
[XmlElement(Type = __typeof(::Manager))]
Employee* Manager;
[XmlElement(__typeof(Int32),
ElementName = S"ObjectNumber"),
XmlElement(__typeof(String),
ElementName = S"ObjectString")]
ArrayList* ExtraInfo;
};
void SerializeObject(String* filename)
{
// Create the XmlSerializer.
XmlSerializer* s = new XmlSerializer(__typeof(Group));
// To write the file, a TextWriter is required.
TextWriter* writer = new StreamWriter(filename);
/* Create an instance of the group to serialize, and set
its properties. */
Group* group = new Group();
group->GroupID = 10.089f;
group->IsActive = false;
Byte temp0 [] = {Convert::ToByte(100)};
group->HexBytes = temp0;
Employee* x = new Employee();
Employee* y = new Employee();
x->Name = S"Jack";
y->Name = S"Jill";
Employee* temp1 [] = {x,y};
group->Employees = temp1;
Manager* mgr = new Manager();
mgr->Name = S"Sara";
mgr->Level = 4;
group->Manager = mgr;
/* Add a number and a string to the
ArrayList returned by the ExtraInfo property. */
group->ExtraInfo = new ArrayList();
group->ExtraInfo->Add(__box(42));
group->ExtraInfo->Add(S"Answer");
// Serialize the object, and close the TextWriter.
s->Serialize(writer, group);
writer->Close();
}
void DeserializeObject(String* filename)
{
FileStream* fs = new FileStream(filename, FileMode::Open);
XmlSerializer* x = new XmlSerializer(__typeof(Group));
Group* g = dynamic_cast<Group*> (x->Deserialize(fs));
Console::WriteLine(g->Manager->Name);
Console::WriteLine(g->GroupID);
Console::WriteLine(g->HexBytes[0]);
IEnumerator* myEnum = g->Employees->GetEnumerator();
while (myEnum->MoveNext())
{
Employee* e = __try_cast<Employee*>(myEnum->Current);
Console::WriteLine(e->Name);
}
}
int main()
{
SerializeObject(S"FirstDoc.xml");
DeserializeObject(S"FirstDoc.xml");
}
[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン .gif)
をクリックします。
必要条件
名前空間: 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 内)
参照
XmlElementAttribute メンバ | System.Xml.Serialization 名前空間 | XmlArrayAttribute | XmlAttributeOverrides | XmlAttributes | XmlElementAttributes | XmlElements | XmlRootAttribute | XmlSerializer | XML シリアル化の概要 | XML シリアル化のオーバーライド | XmlAttributes | 属性を使用した XML シリアル化の制御 | XML シリアル化の例