Udostępnij za pośrednictwem

XmlIgnoreAttribute Klasa

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Xml.Serialization
Zestaw:
System.Xml.XmlSerializer.dll
Zestaw:
System.Xml.ReaderWriter.dll
Zestaw:
System.Xml.dll
Zestaw:
netstandard.dll

Instruuje metodę Serialize(TextWriter, Object) XmlSerializer , aby nie serializować pola publicznego lub publicznej wartości właściwości odczytu/zapisu.

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

Przykłady

W poniższym przykładzie pokazano klasę o nazwie Group, która zawiera pole o nazwie Comment. W przykładzie element jest przypisywany XmlIgnoreAttribute do pola, co powoduje zignorowanie XmlSerializer pola podczas serializacji lub deserializacji wystąpienia klasy.

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

Uwagi

Element XmlIgnoreAttribute należy do rodziny atrybutów, które kontrolują sposób XmlSerializer serializacji lub deserializacji obiektu. Jeśli zastosujesz element XmlIgnoreAttribute do dowolnego elementu członkowskiego klasy, XmlSerializer element ignoruje element członkowski podczas serializacji lub deserializacji wystąpienia klasy. Aby uzyskać pełną listę podobnych atrybutów, zobacz Atrybuty, które kontrolują serializacji XML.

Możesz zastąpić zachowanie spowodowane przez XmlIgnoreAttribute utworzenie XmlAttributes obiektu i ustawienie jego XmlIgnore właściwości na false. Musisz Add XmlAttributes obiekt do wystąpienia XmlAttributeOverrides klasy. Na koniec należy użyć XmlAttributeOverrides obiektu , aby skonstruować wystąpienie XmlSerializer klasy przed wywołaniem Serialize metod lub Deserialize .

Narzędzie definicji schematu XML (Xsd.exe) od czasu do czasu generuje XmlIgnoreAttribute element podczas tworzenia klas na podstawie pliku schematu (xsd). To zachowanie występuje, ponieważ nie można ustawić typów wartości na nullwartość , ale mogą to być wszystkie typy danych XML. W związku z tym narzędzie tworzy dwa pola, gdy napotka typ XML mapowany na typ wartości: jeden do przechowywania wartości, a drugie specjalne pole, które ma formę fieldnameSpecified, gdzie fieldname element jest zastępowany przez nazwę pola lub właściwości. Należy jednak zauważyć, że to pole specjalne jest generowane tylko wtedy, gdy schemat określa, że element nie ma minimalnego wystąpienia (minOccurs = "0") i że element nie ma wartości domyślnej. Ustawia XmlSerializer i sprawdza to pole specjalne, aby określić, czy wartość została ustawiona dla pola lub właściwości. Ponieważ pole specjalne nie może być serializowane, narzędzie stosuje XmlIgnoreAttribute je do niego.

Aby uzyskać więcej informacji na temat używania atrybutów, zobacz Atrybuty.

Uwaga

Możesz użyć słowa XmlIgnore w kodzie zamiast dłuższego XmlIgnoreAttribute.

Konstruktory

XmlIgnoreAttribute()

Inicjuje nowe wystąpienie klasy XmlIgnoreAttribute.

Właściwości

TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu .

(Odziedziczone po Attribute)

Metody

Equals(Object)

Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi.

(Odziedziczone po Attribute)
GetHashCode()

Zwraca wartość skrótu dla tego wystąpienia.

(Odziedziczone po Attribute)
GetType()

Type Pobiera wartość bieżącego wystąpienia.

(Odziedziczone po Object)
IsDefaultAttribute()

W przypadku zastąpienia w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej.

(Odziedziczone po Attribute)
Match(Object)

Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi.

(Odziedziczone po Attribute)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Jawne implementacje interfejsu

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

Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Pobiera informacje o typie dla obiektu, który może służyć do pobierania informacji o typie dla interfejsu.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 1).

(Odziedziczone po Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Umożliwia dostęp do właściwości i metod udostępnianych przez obiekt.

(Odziedziczone po Attribute)

Dotyczy

Zobacz też