XmlIgnoreAttribute Klasse

  • Referenz

Definition

Namespace:
System.Xml.Serialization
Assembly:
System.Xml.XmlSerializer.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll

Weist die Serialize(TextWriter, Object)-Methode von XmlSerializer an, den Eigenschaftswert des öffentlichen Felds oder des öffentlichen Lese-/Schreibzugriffs nicht zu serialisieren.

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
Vererbung
Object
Attribute
XmlIgnoreAttribute
Attribute
AttributeUsageAttribute

Beispiele

Das folgende Beispiel zeigt eine Klasse namens , die ein Feld mit dem Namen Group``Comment". Im Beispiel XmlIgnoreAttribute wird das Feld zugewiesen, wodurch das XmlSerializer Feld beim Serialisieren oder Deserialisieren einer Instanz der Klasse ignoriert wird.

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 von Attributen, die steuert, wie die XmlSerializer Serialisierung oder Deserialisierung eines Objekts gesteuert wird. Wenn Sie das Element einer Klasse anwenden XmlIgnoreAttribute , ignoriert das XmlSerializer Element beim Serialisieren oder Deserialisieren einer Instanz der Klasse. Eine vollständige Liste ähnlicher Attribute finden Sie unter Attribute, die XML-Serialisierung steuern.

Sie können das Verhalten außer Kraft setzen, das durch XmlIgnoreAttribute das Erstellen eines XmlAttributes Objekts verursacht wird, und die XmlIgnore Eigenschaft auf falsefestlegen. Sie müssen das XmlAttributes Objekt einer Instanz der XmlAttributeOverrides Klasse zuweisenAdd. Schließlich müssen Sie das XmlAttributeOverrides Objekt verwenden, um eine Instanz der XmlSerializer Klasse zu erstellen, bevor Sie die Serialize Deserialize Methoden aufrufen.

Das XML-Schemadefinitionstool (Xsd.exe) generiert gelegentlich die XmlIgnoreAttribute Erstellung von Klassen aus einer Schemadatei (XSD). Dieses Verhalten tritt auf, da Werttypen nicht auf nullfestgelegt werden können, aber alle XML-Datentypen können sein. Daher erstellt das Tool zwei Felder, wenn ein XML-Typ auftritt, der einem Werttyp zugeordnet ist: eins, um den Wert und ein anderes Spezialfeld zu halten, das die Form fieldnameSpecifiedenthält, wo dies fieldname durch den Namen des Felds oder der Eigenschaft ersetzt wird. Beachten Sie jedoch, dass dieses spezielle Feld nur generiert wird, wenn das Schema angibt, dass das Element kein Mindestereignis aufweist (minOccurs = "0") und dass das Element keinen Standardwert hat. Die XmlSerializer Sätze und überprüft dieses spezielle Feld, um festzustellen, ob ein Wert für das Feld oder die Eigenschaft festgelegt wurde. Da das Spezielle Feld nicht serialisiert werden darf, wendet das Tool dies XmlIgnoreAttribute an.

Weitere Informationen zur Verwendung von Attributen finden Sie unter Attribute.

Hinweis

Sie können das Wort XmlIgnore in Ihrem Code anstelle der längeren XmlIgnoreAttributeVerwenden.

Konstruktoren

XmlIgnoreAttribute()

Initialisiert eine neue Instanz der XmlIgnoreAttribute-Klasse.

Eigenschaften

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.

(Geerbt von Attribute)
_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.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.

(Geerbt von Attribute)

Gilt für

Siehe auch