XmlIgnoreAttribute 类

定义

命名空间:

System.Xml.Serialization

程序集:

System.Xml.ReaderWriter.dll

Source:

XmlIgnoreAttribute.cs

指示 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 序列化的属性。

可以通过创建 XmlAttributes 对象并将其 属性设置为 XmlIgnorefalse来替代 由 XmlIgnoreAttribute 导致的行为。 必须将 AddXmlAttributes 对象指向 类的 XmlAttributeOverrides 实例。 最后，在调用 Serialize 或 Deserialize 方法之前，XmlAttributeOverrides必须使用 对象构造 类的XmlSerializer实例。

从架构文件 (.xsd) 创建类时， XML 架构定义工具 (Xsd.exe ) 偶尔会生成 XmlIgnoreAttribute 。 发生此行为是因为值类型不能设置为 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)

另请参阅

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• XML 序列化简介
• 如何：指定 XML 流的替代元素名称
• 使用属性控制 XML 序列化
• XML 序列化示例
• XML 架构定义工具 (Xsd.exe)