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, примените его к члену перечисления и присвойте XmlEnumAttributeName свойству значение Single.

Можно переопределить Name значение свойства, XmlEnumAttribute создав экземпляр XmlEnumAttribute класса и назначив его XmlEnum свойству XmlAttributes объекта. Дополнительные сведения см. в XmlAttributeOverrides классе.

Замечание

Вы можете использовать слово XmlEnum в коде вместо более длинного XmlEnumAttribute.

Конструкторы

Имя	Описание
XmlEnumAttribute()	Инициализирует новый экземпляр класса XmlEnumAttribute.
XmlEnumAttribute(String)	Инициализирует новый экземпляр XmlEnumAttribute класса и задает XML-значение, которое XmlSerializer создает или распознает (при сериализации или десериализации перечисления соответственно).

Свойства

Имя	Описание
Name	Возвращает или задает значение, созданное в экземпляре XML-документа при XmlSerializer сериализации перечисления, или значение, распознаваемое при десериализации элемента перечисления.
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)

Методы

Имя	Описание
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)