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. При формировании XML-данных для этого перечисления данные должны быть согласованы со значениями Name свойств. XmlSerializerWhen 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

Примечание

Вы можете использовать слово XmlEnum в коде, а не дольше. XmlEnumAttributeYou can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

Комментарии

Объект принадлежит семейству атрибутов, который управляет тем XmlSerializer , как сериализует или десериализует объект. XmlEnumAttributeThe 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.

Используйте для изменения перечисления, которое XmlSerializer создает или распознает (при сериализации или десериализации класса соответственно). XmlEnumAttributeUse the XmlEnumAttribute to change the enumeration that the XmlSerializer generates or recognizes (when it serializes or deserializes a class, respectively). Например, если перечисление содержит член с именем One, но вы предпочитаете именование Singleвыходных данных XML, примените 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".

Можно Name переопределить значение XmlEnumAttribute XmlEnumAttribute свойства объекта, создав экземпляр класса XmlAttributes и назначив его XmlEnum свойству объекта.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.

Примечание

Вы можете использовать слово XmlEnum в коде, а не дольше. XmlEnumAttributeYou 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 и определяет XML-значение, которое создает или распознает XmlSerializer (при сериализации или десериализации перечисления, соответственно).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

Получает или задает значение, создаваемое в экземпляре XML-документа, когда XmlSerializer сериализует перечисление, или значение, распознаваемое при десериализации члена перечисления.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()

Возвращает строку, представляющую текущий объект.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)

Применяется к

Дополнительно