XmlEnumAttribute XmlEnumAttribute XmlEnumAttribute XmlEnumAttribute Class

Определение

Управляет тем, как 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
Наследование
XmlEnumAttributeXmlEnumAttributeXmlEnumAttributeXmlEnumAttribute
Атрибуты

Примеры

В следующем примере применяется 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

Примечание

Можно использовать слово XmlEnum в коде вместо более длинного XmlEnumAttribute.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 свойство «Один».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 класс и назначается XmlEnum свойство XmlAttributes объекта.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 в коде вместо более длинного XmlEnumAttribute.You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

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

XmlEnumAttribute() XmlEnumAttribute() XmlEnumAttribute() XmlEnumAttribute()

Инициализирует новый экземпляр класса XmlEnumAttribute.Initializes a new instance of the XmlEnumAttribute class.

XmlEnumAttribute(String) XmlEnumAttribute(String) XmlEnumAttribute(String) 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 Name Name 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 TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код для данного экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

При переопределении в производном классе показывает, является ли значение данного экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Явные реализации интерфейса

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

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

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