XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute Class

Definition

Weist die Serialize(TextWriter, Object)-Methode von XmlSerializer an, den Eigenschaftswert des öffentlichen Felds oder des öffentlichen Lese-/Schreibzugriffs nicht zu serialisieren.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)]
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute
type XmlIgnoreAttribute = class
    inherit Attribute
Public Class XmlIgnoreAttribute
Inherits Attribute
Vererbung
XmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttribute
Attribute

Beispiele

Das folgende Beispiel zeigt eine Klasse namens Group, enthält ein Feld namens Comment.The following example shows a class named Group, which contains a field named Comment. Das Beispiel weist die XmlIgnoreAttribute angewiesen wird dem Feld, wodurch die XmlSerializer , um das Feld bei der Serialisierung oder Deserialisierung einer Instanz der Klasse zu ignorieren.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

Hinweise

Die XmlIgnoreAttribute gehört zu einer Familie der Attribute, die steuert, wie die XmlSerializer Serialisieren oder Deserialisieren eines Objekts.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Wenn Sie anwenden, die XmlIgnoreAttribute auf einen Member einer Klasse, die XmlSerializer ignoriert das Element bei der Serialisierung oder Deserialisierung einer Instanz der Klasse.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. Eine vollständige Liste ähnlicher Attribute, finden Sie unter Attributes, die Control XML Serialization.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Sie können das Verhalten verursacht durch Überschreiben der XmlIgnoreAttribute durch das Erstellen einer XmlAttributes -Objekt und legt seine XmlIgnore Eigenschaft, um false.You can override the behavior caused by the XmlIgnoreAttribute by creating an XmlAttributes object, and setting its XmlIgnore property to false. Sie müssen Add der XmlAttributes Objekt mit einer Instanz von der XmlAttributeOverrides Klasse.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. Verwenden Sie abschließend die XmlAttributeOverrides Objekt zum Erstellen einer Instanz von der XmlSerializer -Klasse vor dem Aufruf der Serialize oder Deserialize Methoden.Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

Die XML Schema Definition Tool (Xsd.exe) manchen Fällen generiert die XmlIgnoreAttribute beim Erstellen von Klassen aus einer Schema-Datei (.xsd).The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlIgnoreAttribute when creating classes from a schema file (.xsd). Dieses Verhalten tritt auf, weil Werttypen nicht können, um festgelegt werden null, aber alle XML-Datentypen sind möglich.This behavior occurs because value types cannot be set to null, but all XML data types can be. Das Tool erstellt daher zwei Felder, wenn einen XML-Typ gefunden wird, der einen Werttyp zugeordnet: eines für den Wert und ein weiteres spezielle Feld der Form von fieldnameSpecified, wobei die fieldname durch den Namen des Felds oder der Eigenschaft ersetzt wird.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. Beachten Sie jedoch, dass dieses spezielle Feld nur generiert wird, wenn das Schema gibt an, dass das Element nicht auftreten (MinOccurs = "0") und dass das Element keinen Standardwert hat.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. Die XmlSerializer legt fest, und prüft dieses spezielle Feld, um festzustellen, ob ein Wert für das Feld oder die Eigenschaft festgelegt wurde.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. Da das spezielle Feld nicht serialisiert werden muss, um das Tool wendet den XmlIgnoreAttribute zuzuweisen.Because the special field must not be serialized, the tool applies the XmlIgnoreAttribute to it.

Weitere Informationen zum Verwenden von Attributen finden Sie unter Attribute.For more information about using attributes, see Attributes.

Hinweis

Sie können das Wort XmlIgnore in Ihrem Code anstelle des längeren XmlIgnoreAttribute.You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Konstruktoren

XmlIgnoreAttribute() XmlIgnoreAttribute() XmlIgnoreAttribute() XmlIgnoreAttribute()

Initialisiert eine neue Instanz der XmlIgnoreAttribute-Klasse.Initializes a new instance of the XmlIgnoreAttribute class.

Methoden

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

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

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

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

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

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

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

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.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)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.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()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

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

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.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)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.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)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 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)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Eigenschaften

TypeId TypeId TypeId TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Gilt für:

Siehe auch