XmlEnumAttribute Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Управляет тем, как 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
- Наследование
- Атрибуты
Примеры
В следующем примере применяется XmlEnumAttribute к членам перечисления. XmlSerializer При создании XML-данных для этого перечисления данные соответствуют значениям Name свойств.
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
в коде.
Комментарии
Принадлежит XmlEnumAttribute к семейству атрибутов, которые управляют тем, как XmlSerializer сериализует или десериализирует объект. Полный список аналогичных атрибутов см. в разделе «Атрибуты, управляющие сериализацией XML».
XmlEnumAttribute Используйте для изменения перечисления, которое XmlSerializer создает или распознает (при сериализации или десериализации класса соответственно). Например, если перечисление содержит именованный член, но вы предпочитаете, чтобы выходные данные XML были названыOne``Single
, примените XmlEnumAttribute его к члену перечисления и присвойте Name свойству значение Single.
Можно переопределить Name значение свойства объекта XmlEnumAttribute , создав экземпляр XmlEnumAttribute класса и назначив его свойству XmlEnum XmlAttributes объекта. Дополнительные сведения см. в XmlAttributeOverrides разделе о классе.
Примечание
Вместо более длинных XmlEnumAttributeслов можно использовать слово XmlEnum
в коде.
Конструкторы
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) |
Явные реализации интерфейса
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute) |
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса. (Унаследовано от Attribute) |
_Attribute.GetTypeInfoCount(UInt32) |
Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute) |
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Предоставляет доступ к открытым свойствам и методам объекта. (Унаследовано от Attribute) |
Применяется к
См. также раздел
- Serialize(TextWriter, Object)
- Deserialize(Stream)
- XmlSerializer
- XmlEnum
- XmlAttributeOverrides
- XmlAttributes
- Введение в сериализацию XML
- Практическое руководство. Указание имени альтернативного элемента для потока XML
- Управление сериализацией XML с использованием атрибутов
- Примеры сериализации XML
- XML Schema Definition Tool (Xsd.exe)