XmlEnumAttribute クラス

定義

XmlSerializer が列挙体メンバーをシリアル化する方法を制御します。Controls how the XmlSerializer serializes an enumeration member.

public ref class XmlEnumAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field)]
public class XmlEnumAttribute : Attribute
type XmlEnumAttribute = class
    inherit Attribute
Public Class XmlEnumAttribute
Inherits Attribute
継承
XmlEnumAttribute
属性

次の例では、列挙体のメンバーに XmlEnumAttribute を適用します。The following example applies the XmlEnumAttribute to the members of an enumeration. XmlSerializer がこの列挙体の XML データを生成する場合、データは Name プロパティの値に準拠します。When the XmlSerializer generates XML data for this enumeration, the data conforms to the values of the Name properties.

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

public enum EmployeeStatus
{
   [XmlEnum(Name = "Single")]
   One,
   [XmlEnum(Name = "Double")]
   Two,
   [XmlEnum(Name = "Triple")]
   Three
}
   
Public Enum EmployeeStatus
   <XmlEnum("Single")> One = 1
   <XmlEnum("Double")> Two = 2
   <XmlEnum("Triple")> Three = 3
End Enum

注意

長い XmlEnumAttributeではなく、コード内の XmlEnum という単語を使用できます。You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

注釈

XmlEnumAttribute は、XmlSerializer がオブジェクトをシリアル化または逆シリアル化する方法を制御する属性のファミリに属しています。The XmlEnumAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. 類似する属性の完全な一覧については、「 XML シリアル化を制御する属性」を参照してください。For a complete list of similar attributes, see Attributes That Control XML Serialization.

XmlEnumAttribute を使用して、XmlSerializer によって生成または認識される列挙体 (クラスをそれぞれシリアル化または逆シリアル化するとき) を変更します。Use the XmlEnumAttribute to change the enumeration that the XmlSerializer generates or recognizes (when it serializes or deserializes a class, respectively). たとえば、列挙に Oneという名前のメンバーが含まれていても、その XML 出力に Singleという名前を付けたい場合は、XmlEnumAttribute を列挙メンバーに適用し、Name プロパティを "Single" に設定します。For example, if an enumeration contains a member named One, but you prefer that the XML output be named Single, apply the XmlEnumAttribute to the enumeration member and set the Name property to "Single".

XmlEnumAttribute クラスのインスタンスを作成し、それを XmlAttributes オブジェクトの XmlEnum プロパティに割り当てることによって、XmlEnumAttributeName プロパティ値をオーバーライドできます。You can override the Name property value of an XmlEnumAttribute by creating an instance of the XmlEnumAttribute class and assigning it to the XmlEnum property of an XmlAttributes object. 詳細については、XmlAttributeOverrides クラスを参照してください。For details, see the XmlAttributeOverrides class.

注意

長い XmlEnumAttributeではなく、コード内の XmlEnum という単語を使用できます。You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

コンストラクター

XmlEnumAttribute()

XmlEnumAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the XmlEnumAttribute class.

XmlEnumAttribute(String)

XmlEnumAttribute クラスの新しいインスタンスを初期化し、XmlSerializer が生成する (列挙体をシリアル化する場合) または認識する (列挙体を逆シリアル化する場合) XML 値を指定します。Initializes a new instance of the XmlEnumAttribute class, and specifies the XML value that the XmlSerializer generates or recognizes (when it serializes or deserializes the enumeration, respectively).

プロパティ

Name

XmlSerializer が列挙体をシリアル化する場合は XML ドキュメント インスタンスに生成された値を、列挙体メンバーを逆シリアル化する場合は認識した値を、取得または設定します。Gets or sets the value generated in an XML-document instance when the XmlSerializer serializes an enumeration, or the value recognized when it deserializes the enumeration member.

TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(継承元 Attribute)
GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(継承元 Attribute)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
IsDefaultAttribute()

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)
Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象

こちらもご覧ください