XmlIgnoreAttribute Klasse

Definition

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 Group, die ein Feld mit dem Namen Commententhält. Im Beispiel wird das XmlIgnoreAttribute Feld zugewiesen, wodurch das XmlSerializer Feld ignoriert werden soll, wenn eine Instanz der Klasse serialisiert oder deserialisiert wird.

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

Dies XmlIgnoreAttribute gehört zu einer Familie von Attributen, die steuert, wie das XmlSerializer Serialisieren oder Deserialisieren eines Objekts. Wenn Sie das XmlIgnoreAttribute Element auf ein Element einer Klasse anwenden, ignoriert das XmlSerializer Element beim Serialisieren oder Deserialisieren einer Instanz der Klasse. Eine vollständige Liste ähnlicher Attribute finden Sie unter Attributes That Control XML Serialization.

Sie können das durch das XmlIgnoreAttribute Erstellen eines XmlAttributes Objekts verursachte Verhalten überschreiben und dessen XmlIgnore Eigenschaft auf falsefestlegen. Sie müssen Add das XmlAttributes Objekt einer Instanz der XmlAttributeOverrides Klasse zuweisen. Schließlich müssen Sie das XmlAttributeOverrides Objekt verwenden, um eine Instanz der XmlSerializer Klasse zu erstellen, bevor Sie die Serialize Methoden aufrufen Deserialize .

Das XML-Schemadefinitionstool (Xsd.exe) generiert gelegentlich das XmlIgnoreAttribute Erstellen von Klassen aus einer Schemadatei (XSD). Dieses Verhalten tritt auf, da Werttypen nicht auf festgelegt nullwerden 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: ein Feld, das den Wert enthält, und ein weiteres spezielles Feld, das die Form fieldnameSpecifiedverwendet, wobei 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 Mindestelement (minOccurs = "0") aufweist und dass das Element keinen Standardwert aufweist. Mit XmlSerializer den Sätzen und Überprüfungen dieses speziellen Felds wird ermittelt, ob ein Wert für das Feld oder die Eigenschaft festgelegt wurde. Da das Spezielle Feld nicht serialisiert werden darf, wendet das Tool darauf XmlIgnoreAttribute an.

Weitere Informationen zur Verwendung von Attributen finden Sie unter "Attribute".

Weitere Informationen

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• Einführung in die XML-Serialisierung
• Vorgehensweise: Angeben eines alternativen Elementnamens für einen XML-Stream
• Steuern der XML-Serialisierung mithilfe von Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)