XmlEnumAttribute クラス
XmlSerializer が列挙体メンバをシリアル化する方法を制御します。
この型のすべてのメンバの一覧については、XmlEnumAttribute メンバ を参照してください。
System.Object
System.Attribute
System.Xml.Serialization.XmlEnumAttribute
<AttributeUsage(AttributeTargets.Field)>
Public Class XmlEnumAttribute Inherits Attribute
[C#]
[AttributeUsage(AttributeTargets.Field)]
public class XmlEnumAttribute : Attribute
[C++]
[AttributeUsage(AttributeTargets::Field)]
public __gc class XmlEnumAttribute : public Attribute
[JScript]
public
AttributeUsage(AttributeTargets.Field)
class XmlEnumAttribute extends Attribute
スレッドセーフ
この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。
解説
XmlEnumAttribute は、 XmlSerializer がオブジェクトをシリアル化または逆シリアル化する方法を制御する一連の属性のうちの 1 つです。類似する属性の完全な一覧については、「 XML シリアル化を制御する属性 」を参照してください。
XmlSerializer が生成する (クラスをシリアル化する場合) または認識する (クラスを逆シリアル化する場合) 列挙体を変更するには、 XmlEnumAttribute を使用します。たとえば、One という名前のメンバが含まれている列挙体の XML 出力の名前を Single にする場合は、 XmlEnumAttribute をその列挙体メンバに適用し、 Name プロパティを "Single" に設定します。
XmlEnumAttribute の Name プロパティ値をオーバーライドするには、 XmlEnumAttribute クラスのインスタンスを作成し、そのインスタンスを XmlAttributes オブジェクトの XmlEnum プロパティに割り当てます。詳細については、 XmlAttributeOverrides クラスのトピックを参照してください。
メモ コードでは、 XmlEnumAttribute の代わりに XmlEnum という短い語を使用できます。
使用例
[Visual Basic, C#, C++] XmlEnumAttribute を列挙体のメンバに適用する例を次に示します。 XmlSerializer がこの列挙体に対応する XML データを生成する場合は、 Name プロパティの値に適合するようにデータを生成します。
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 __value enum EmployeeStatus
{
[XmlEnum(Name = S"Single")]
One,
[XmlEnum(Name = S"Double")]
Two,
[XmlEnum(Name = S"Triple")]
Three
};
[Visual Basic, C#, C++] メモ コードでは、 XmlEnumAttribute の代わりに XmlEnum という短い語を使用できます。
[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 内)
参照
XmlEnumAttribute メンバ | System.Xml.Serialization 名前空間 | Serialize | Deserialize | XmlSerializer | XmlEnum | XmlAttributeOverrides | XmlAttributes | XML シリアル化の概要 | XML シリアル化のオーバーライド | XmlAttributes | 属性を使用した XML シリアル化の制御 | XML シリアル化の例