XmlIgnoreAttribute Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Указывает методу 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 AttributePublic Class XmlIgnoreAttribute
Inherits Attribute- Наследование
- Атрибуты
Примеры
В следующем примере показан класс с именем Group, который содержит поле с именем Comment. В этом примере назначается XmlIgnoreAttribute поле, что позволяет XmlSerializer игнорировать поле при сериализации или десериализации экземпляра класса.
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. Объект должен находиться AddXmlAttributes в экземпляре XmlAttributeOverrides класса. Наконец, необходимо использовать XmlAttributeOverrides объект для создания экземпляра XmlSerializer класса перед вызовом или Deserialize методамиSerialize.
Средство определения схемы XML (Xsd.exe) иногда создает XmlIgnoreAttribute классы из файла схемы (XSD). Это происходит, так как типы значений не могут быть заданы null, но все типы данных XML могут быть. Поэтому средство создает два поля при обнаружении типа XML, который сопоставляется с типом значения: один для хранения значения и другого специального поля, которое принимает форму fieldnameSpecified, где fieldname оно заменяется именем поля или свойства. Обратите внимание, что это специальное поле создается только в том случае, если схема указывает, что элемент не имеет минимального вхождения (minOccurs = "0") и что элемент не имеет значения по умолчанию. Наборы XmlSerializer и проверки этого специального поля, чтобы определить, задано ли значение для поля или свойства. Так как специальное поле не должно быть сериализовано, средство применяется XmlIgnoreAttribute к нему.
Дополнительные сведения об использовании атрибутов см. в разделе "Атрибуты".
Замечание
Вы можете использовать слово XmlIgnore в коде вместо более длинного XmlIgnoreAttribute.
Конструкторы
| Имя | Описание |
|---|---|
| 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) |
