XmlEnumAttribute 類別

定義

命名空間:

System.Xml.Serialization

組件:

netstandard.dll, System.Xml.ReaderWriter.dll

來源:

XmlEnumAttribute.cs

控制 XmlSerializer 串行化列舉成員的方式。

public ref class XmlEnumAttribute : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Field)>]
type XmlEnumAttribute = class
    inherit Attribute

Public Class XmlEnumAttribute
Inherits Attribute

繼承

Object

Attribute

XmlEnumAttribute

屬性

AttributeUsageAttribute

範例

以下範例將 應用 XmlEnumAttribute 於列舉的成員。 當 為 XmlSerializer 此枚舉產生 XML 資料時，資料會符合屬性的 Name 值。

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

備註

你可以在程式碼中使用這個詞 XmlEnum ，而不是較長 XmlEnumAttribute的 。

備註

屬於 XmlEnumAttribute 一組屬性，控制物件如何 XmlSerializer 序列化或反序列化。 如需類似屬性的完整清單，請參閱 控制 XML 串行化的屬性。

使用 來 XmlEnumAttribute 更改所 XmlSerializer 產生或識別的列舉（分別是序列化或反序列化類別）。 例如，如果一個枚舉包含一個名為 One的成員，但你希望 XML 輸出有名稱 Single，請將 套用 XmlEnumAttribute 到 枚舉成員，並將屬性 Name 設為「Single」。

你可以透過建立該類別的實例XmlEnumAttribute並將其指派到XmlEnum物件的XmlAttributes屬性，來覆寫 Name 的XmlEnumAttribute屬性值。 詳情請參見課程。XmlAttributeOverrides

備註

你可以在程式碼中使用這個詞 XmlEnum ，而不是較長 XmlEnumAttribute的 。

建構函式

名稱	Description
XmlEnumAttribute()	初始化 XmlEnumAttribute 類別的新執行個體。
XmlEnumAttribute(String)	初始化該類別的新實例 XmlEnumAttribute ，並指定該 XmlSerializer 類別所產生或識別的 XML 值（分別序列化或反序列化列舉）。

屬性

名稱	Description
Name	在序列化列舉時，取得或設定 XML 文件實例 XmlSerializer 中產生的值，或在反序列化列舉成員時識別的值。
TypeId	在衍生類別中實作時，取得這個 Attribute的唯一標識碼。 (繼承來源 Attribute)

方法

名稱	Description
Equals(Object)	傳回值，這個值表示這個實例是否等於指定的物件。 (繼承來源 Attribute)
GetHashCode()	傳回這個實例的哈希碼。 (繼承來源 Attribute)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
IsDefaultAttribute()	在衍生類別中覆寫時，指出這個實例的值是否為衍生類別的預設值。 (繼承來源 Attribute)
Match(Object)	在衍生類別中覆寫時，傳回值，指出這個實例是否等於指定的物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)

另請參閱

• Serialize(TextWriter, Object)
• Deserialize(Stream)
• XmlSerializer
• XmlEnum
• XmlAttributeOverrides
• XmlAttributes
• XML 序列化簡介
• 如何：為 XML 串流指定替代元素名稱
• 使用屬性控制 XML 串行化
• XML 序列化範例
• XML 架構定義工具 （Xsd.exe）