XmlIgnoreAttribute Klasse

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)]
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
XmlIgnoreAttribute
Attribute

Beispiele

Das folgende Beispiel zeigt eine Klasse mit dem Namen Group , die ein Feld mit dem Namen enthält Comment .The following example shows a class named Group, which contains a field named Comment. Im Beispiel wird das-Feld dem- XmlIgnoreAttribute Feld zugewiesen, sodass das- XmlSerializer Feld ignoriert, wenn eine Instanz der-Klasse serialisiert oder deserialisiert wird.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

Der XmlIgnoreAttribute gehört zu einer Gruppe von Attributen, die steuert, wie XmlSerializer ein Objekt serialisiert oder deserialisiert.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Wenn Sie das XmlIgnoreAttribute auf einen Member einer Klasse anwenden, ignoriert den XmlSerializer Member beim Serialisieren oder Deserialisieren 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 umfassende Liste mit ähnlichen Attributen finden Sie unter Attribute, die die XML-Serialisierung steuern.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Sie können das von verursachte Verhalten überschreiben XmlIgnoreAttribute , indem Sie ein XmlAttributes -Objekt erstellen und dessen- XmlIgnore Eigenschaft auf festlegen 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 das- XmlAttributes Objekt zu einer Instanz der- XmlAttributeOverrides Klasse hinzu.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. Schließlich müssen Sie das- XmlAttributeOverrides Objekt verwenden, um eine Instanz der-Klasse zu erstellen, XmlSerializer bevor Sie die-Methode oder die-Methode aufzurufen Serialize Deserialize .Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

Das XML Schema Definition-Tool (Xsd.exe) generiert gelegentlich den, XmlIgnoreAttribute Wenn Klassen aus einer Schema Datei (. xsd) erstellt werden.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 auf festgelegt werden können null , aber alle XML-Datentypen können sein.This behavior occurs because value types cannot be set to null, but all XML data types can be. Daher erstellt das Tool zwei Felder, wenn ein XML-Typ gefunden wird, der einem Werttyp zugeordnet ist: einen, der den Wert enthalten soll, und ein anderes spezielles Feld, das das Format fieldnameSpecified hat, wobei der 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 angibt, dass das Element kein minimal vorkommen hat (minvorkommen = "0") und dass das Element keinen Standardwert aufweist.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. Der XmlSerializer legt dieses spezielle Feld fest und überprüft dieses, um zu bestimmen, 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 besondere Feld nicht serialisiert werden darf, wendet das Tool XmlIgnoreAttribute darauf an.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 der längeren verwenden XmlIgnoreAttribute .You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Konstruktoren

XmlIgnoreAttribute()

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

Eigenschaften

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.

(Geerbt von Attribute)

Methoden

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.

(Geerbt von Attribute)
GetHashCode()

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

(Geerbt von Attribute)
GetType()

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

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

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

(Geerbt von Object)
ToString()

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

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

(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.Retrieves the type information for an object, which can be used to get the type information for an interface.

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

(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.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch