XmlEnumAttribute クラス

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

XmlEnumAttribute クラス

XmlSerializer が列挙体メンバをシリアル化する方法を制御します。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Field)> _
Public Class XmlEnumAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As XmlEnumAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Field)] 
public class XmlEnumAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Field)] 
public ref class XmlEnumAttribute : public
 Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Field) */ 
public class XmlEnumAttribute extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Field) 
public class XmlEnumAttribute extends
 Attribute

解説

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

XmlSerializer が生成する (クラスをシリアル化する場合) または認識する (クラスを逆シリアル化する場合) 列挙体を変更するには、XmlEnumAttribute を使用します。たとえば、One という名前のメンバが含まれている列挙体の XML 出力の名前を Single にする場合は、XmlEnumAttribute をその列挙体メンバに適用し、Name プロパティを "Single" に設定します。

XmlEnumAttribute の Name プロパティ値をオーバーライドするには、XmlEnumAttribute クラスのインスタンスを作成し、そのインスタンスを XmlAttributes オブジェクトの XmlEnum プロパティに割り当てます。詳細については、XmlAttributeOverrides クラスのトピックを参照してください。

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

使用例

XmlEnumAttribute を列挙体のメンバに適用する例を次に示します。XmlSerializer がこの列挙体に対応する XML データを生成する場合は、Name プロパティの値に適合するようにデータを生成します。

Visual Basic

Public Enum EmployeeStatus
   <XmlEnum("Single")> One = 1
   <XmlEnum("Double")> Two = 2
   <XmlEnum("Triple")> Three = 3
End Enum

C#

public enum EmployeeStatus
{
   [XmlEnum(Name = "Single")]
   One,
   [XmlEnum(Name = "Double")]
   Two,
   [XmlEnum(Name = "Triple")]
   Three
}
   

C++

public enum class EmployeeStatus
{
   [XmlEnum(Name = "Single")]
   One,
   [XmlEnum(Name = "Double")]
   Two,
   [XmlEnum(Name = "Triple")]
   Three
};

J#

public class EmployeeStatus
{
    /** @attribute XmlEnum(Name = "Single")
     */
    public static int one;
    /** @attribute XmlEnum(Name = "Double")
     */
    public static int two;
    /** @attribute XmlEnum(Name = "Triple")
     */
    public static int three;
} //EmployeeStatus

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

継承階層

System.Object
   System.Attribute
    System.Xml.Serialization.XmlEnumAttribute

スレッド セーフ

この型の 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

参照

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