XmlTypeAttribute クラスとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

XmlTypeAttribute クラス

この属性が適用された対象が XmlSerializer によってシリアル化されるときに生成される XML スキーマを制御します。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct
 Or AttributeTargets.Enum Or AttributeTargets.Interface)>
 _
Public Class XmlTypeAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As XmlTypeAttribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface)]
 
public class XmlTypeAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Struct|AttributeTargets::Enum|AttributeTargets::Interface)]
 
public ref class XmlTypeAttribute : public
 Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface)
 */ 
public class XmlTypeAttribute extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface)
 
public class XmlTypeAttribute extends
 Attribute

解説

XmlTypeAttribute は、XmlSerializer がオブジェクトをシリアル化または逆シリアル化する方法を制御する一連の属性の 1 つです。類似する属性の完全な一覧については、「XML シリアル化を制御する属性」を参照してください。

XmlTypeAttribute は、クラス、構造体、列挙体、またはインターフェイスの宣言に適用できます。

XmlTypeAttribute をクラスに適用し、XML 型の名前空間、XML 型名、および XML スキーマドキュメントにその型を含めるかどうかを指定します。XmlTypeAttribute クラスのプロパティの設定結果を確認するには、アプリケーションをコンパイルして実行可能ファイルまたは DLL を生成し、生成されたファイルを XML スキーマ定義ツール (Xsd.exe) に渡します。このツールは、型定義を含むスキーマを作成します。

メモ
IncludeInSchema プロパティを false に設定した場合、XML スキーマ定義ツール (Xsd.exe) は、スキーマにその型を含めません。既定では、各パブリッククラスに対して、XSD ツールは `complexType` とその型の要素を生成します。

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

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

使用例

XmlTypeAttribute が適用された 2 つのクラスの例を次に示します。

Visual Basic

<XmlType(Namespace := "http://www.cpandl.com",
 _
 TypeName := "GroupMember")> _
Public Class Person
    Public Name As String
End Class

<XmlType(Namespace := "http://www.cohowinery.com",
 _
 TypeName := "GroupAddress")> _ 
Public Class Address
    
    Public Line1 As String
    Public Line2 As String
    Public City As String
    Public State As String
    Public Zip As String
End Class

Public Class Group
    Public Staff() As Person
    Public Manager As Person
    Public Location As Address
End Class

[XmlType(Namespace = "http://www.cpandl.com",
TypeName = "GroupMember")]
public class Person
{
   public string Name;
}

[XmlType(Namespace = "http://www.cohowinery.com",
TypeName = "GroupAddress")]
public class Address
{
   public string Line1;
   public string Line2;
   public string City;
   public string State;
   public string Zip;
}

public class Group
{
   public Person[] Staff;
   public Person Manager;
   public Address Location;
}

C++

[XmlType(Namespace="http://www.cpandl.com",
TypeName="GroupMember")]
public ref class Person
{
public:
   String^ Name;
};


[XmlType(Namespace="http://www.cohowinery.com",
TypeName="GroupAddress")]
public ref class Address
{
public:
   String^ Line1;
   String^ Line2;
   String^ City;
   String^ State;
   String^ Zip;
};

public ref class Group
{
public:
   array<Person^>^Staff;
   Person^ Manager;
   Address^ Location;
};

/** @attribute XmlType(Namespace = "http://www.cpandl.com"
,
    TypeName = "GroupMember")
 */
public class Person
{
    public String name;
} //Person

/** @attribute XmlType(Namespace = "http://www.cohowinery.com"
,
    TypeName = "GroupAddress")
 */
public class Address
{
    public String line1;
    public String line2;
    public String city;
    public String state;
    public String zip;
} //Address

public class Group
{
    public Person staff[];
    public Person manager;
    public Address location;
} //Group