XmlIgnoreAttribute Class

Definition

Инструктирует метод Serialize(TextWriter, Object), принадлежащий XmlSerializer, не сериализовывать значение открытого поля или открытого свойства чтения/записи.Instructs the Serialize(TextWriter, Object) method of the XmlSerializer not to serialize the public field or public read/write property value.

public ref class XmlIgnoreAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute
type XmlIgnoreAttribute = class
    inherit Attribute
Public Class XmlIgnoreAttribute
Inherits Attribute
Inheritance
XmlIgnoreAttribute
Attributes

Examples

В следующем примере показан класс с именем Group, который содержит поле с именем Comment.The following example shows a class named Group, which contains a field named Comment. Этот пример присваивает XmlIgnoreAttribute полю, тем самым указывая XmlSerializer игнорировать поле при сериализации или десериализации экземпляра класса.The example assigns the XmlIgnoreAttribute to the field, thereby instructing the XmlSerializer to ignore the field when serializing or deserializing an instance of the class.

public ref class Group
{
public:

   // The XmlSerializer ignores this field.

   [XmlIgnore]
   String^ Comment;

   // The XmlSerializer serializes this field.
   String^ GroupName;
};

public class Group
{
   // The XmlSerializer ignores this field.
   [XmlIgnore]
   public string Comment;

   // The XmlSerializer serializes this field.
   public string GroupName;
}

Public Class Group
    ' the XmlSerializer ignores this field.
    <XmlIgnore()> Public Comment As String
    
    ' The XmlSerializer serializes this field.
    Public GroupName As String
End Class

Remarks

XmlIgnoreAttribute принадлежит семейству атрибутов, который управляет тем, как XmlSerializer сериализует или десериализует объект.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. При применении XmlIgnoreAttribute к любому члену класса XmlSerializer игнорирует элемент при сериализации или десериализации экземпляра класса.If you apply the XmlIgnoreAttribute to any member of a class, the XmlSerializer ignores the member when serializing or deserializing an instance of the class. Полный список схожих атрибутов см. в разделе атрибуты, управляющие СЕРИАЛИЗАЦИЕЙ XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Поведение, вызванное XmlIgnoreAttribute, можно переопределить, создав XmlAttributes объект и установив для его свойства XmlIgnore значение false.You can override the behavior caused by the XmlIgnoreAttribute by creating an XmlAttributes object, and setting its XmlIgnore property to false. Необходимо Add объект XmlAttributes в экземпляр класса XmlAttributeOverrides.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. Наконец, необходимо использовать объект XmlAttributeOverrides для создания экземпляра класса XmlSerializer перед вызовом методов Serialize или Deserialize.Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

Средство определения схемы XML (XSD. exe) иногда создает XmlIgnoreAttribute при создании классов из файла схемы (. xsd).The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlIgnoreAttribute when creating classes from a schema file (.xsd). Это происходит потому, что типы значений не могут иметь значение null, но все типы данных XML могут быть.This behavior occurs because value types cannot be set to null, but all XML data types can be. Поэтому средство создает два поля при обнаружении типа XML, сопоставляемого с типом значения: один для хранения значения и другое специальное поле, которое принимает форму fieldnameSpecified, где fieldname заменяется именем поля или свойства.Therefore, the tool creates two fields when it encounters an XML type that maps to a value type: one to hold the value and another special field that takes the form of fieldnameSpecified, where the fieldname is replaced by the name of the field or property. Однако обратите внимание, что это специальное поле создается только в том случае, если схема указывает, что у элемента нет минимального вхождения (minOccurs = "0") и что у элемента нет значения по умолчанию.Notice, however, that this special field is generated only when the schema specifies that the element has no minimum occurrence (minOccurs = "0") and that the element has no default value. XmlSerializer задает и проверяет это специальное поле, чтобы определить, было ли установлено значение для поля или свойства.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. Поскольку специальное поле не должно быть сериализовано, инструмент применяет к нему XmlIgnoreAttribute.Because the special field must not be serialized, the tool applies the XmlIgnoreAttribute to it.

Дополнительные сведения об использовании атрибутов см. в разделе атрибуты.For more information about using attributes, see Attributes.

Note

Вместо более длинного XmlIgnoreAttributeможно использовать слово XmlIgnore в коде.You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Constructors

XmlIgnoreAttribute()

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

Properties

TypeId

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

(Inherited from Attribute)

Methods

Equals(Object)

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

(Inherited from Attribute)
GetHashCode()

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

(Inherited from Attribute)
GetType()

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

(Inherited from Object)
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)

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

(Inherited from Attribute)
MemberwiseClone()

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

(Inherited from Object)
ToString()

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

(Inherited from Object)

Explicit Interface Implementations

_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)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.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)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (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)

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

(Inherited from Attribute)

Applies to

See also