XmlIgnoreAttribute Класс

Ссылка

Определение

Пространство имен:: System.Xml.Serialization

Сборка:: System.Xml.XmlSerializer.dll

Сборка:: System.Xml.ReaderWriter.dll

Сборка:: System.Xml.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Инструктирует метод Serialize(TextWriter, Object), принадлежащий XmlSerializer, не сериализовывать значение открытого поля или открытого свойства чтения/записи.

public ref class XmlIgnoreAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)>]
type XmlIgnoreAttribute = class
    inherit Attribute

Public Class XmlIgnoreAttribute
Inherits Attribute

Наследование: Object

Attribute
XmlIgnoreAttribute

Атрибуты: AttributeUsageAttribute

Примеры

В следующем примере показан класс с именем Group, который содержит поле с именем Comment. В примере назначается XmlIgnoreAttribute поле, тем самым предписывая XmlSerializer игнорировать поле при сериализации или десериализации экземпляра класса.

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

Принадлежит XmlIgnoreAttribute к семейству атрибутов, которые управляют тем, как XmlSerializer сериализует или десериализирует объект. При применении XmlIgnoreAttribute к любому члену класса он XmlSerializer игнорирует его при сериализации или десериализации экземпляра класса. Полный список аналогичных атрибутов см. в разделе «Атрибуты, управляющие сериализацией XML».

Вы можете переопределить поведение, вызванное XmlIgnoreAttribute созданием XmlAttributes объекта, и задать для его свойства значение XmlIgnore false. Объект должен быть Add XmlAttributes объектом экземпляра XmlAttributeOverrides класса. Наконец, необходимо использовать XmlAttributeOverrides объект для создания экземпляра XmlSerializer класса перед вызовом или Deserialize методамиSerialize.

Средство определения схемы XML (Xsd.exe) иногда создает XmlIgnoreAttribute классы из файла схемы (XSD). Это происходит потому, что типы значений не могут быть заданы null, но все типы данных XML могут быть. Таким образом, средство создает два поля при обнаружении типа XML, который сопоставляется с типом значения: один для хранения значения и другого специального поля, принимающего fieldnameSpecifiedформу, где fieldname заменяется именем поля или свойства. Обратите внимание, что это специальное поле создается только в том случае, если схема указывает, что элемент не имеет минимального вхождения (minOccurs = "0") и что элемент не имеет значения по умолчанию. Наборы XmlSerializer и проверяет это специальное поле, чтобы определить, задано ли значение для поля или свойства. Так как специальное поле не должно быть сериализовано, оно применяется XmlIgnoreAttribute к нему.

Дополнительные сведения об использовании атрибутов см. в разделе "Атрибуты".

Примечание

Вместо более длинных XmlIgnoreAttributeслов можно использовать слово XmlIgnore в коде.

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

XmlIgnoreAttribute()

Инициализирует новый экземпляр класса XmlIgnoreAttribute.

Свойства

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)

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

Поделиться через