XmlIgnoreAttribute Osztály

Definíció

Névtér:

System.Xml.Serialization

Szerelvények:

netstandard.dll, System.Xml.ReaderWriter.dll

Forrás:

XmlIgnoreAttribute.cs

Arra utasítja a Serialize(TextWriter, Object)XmlSerializer metódust, hogy ne szerializálja a nyilvános mezőt vagy a nyilvános olvasási/írási tulajdonság értékét.

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

Öröklődés

Object

Attribute

XmlIgnoreAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példában egy nevesített Grouposztály látható, amely egy nevesített Commentmezőt tartalmaz. A példa hozzárendeli a XmlIgnoreAttribute mezőt a mezőhöz, így utasítja a XmlSerializer mező figyelmen kívül hagyására az osztály egy példányának szerializálása vagy deszerializálása során.

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

Megjegyzések

Az XmlIgnoreAttribute attribútumcsalád az objektum szerializálásának vagy deszerializálásának módját szabályozza XmlSerializer . Ha az osztály bármely tagjára alkalmazza, XmlIgnoreAttribute a XmlSerializer rendszer figyelmen kívül hagyja a tagot az osztály egy példányának szerializálása vagy deszerializálása során. A hasonló attribútumok teljes listáját az XML-szerializálást vezérlő attribútumok című témakörben találja.

Felülbírálhatja az objektum által XmlIgnoreAttribute okozott viselkedést, XmlAttributes és beállíthatja annak tulajdonságátXmlIgnorefalse. Az objektumnak az Add osztály egy példányához XmlAttributes kell lennieXmlAttributeOverrides. Végül az XmlAttributeOverrides objektummal kell létrehoznia az osztály egy példányát, XmlSerializer mielőtt meghívja a Serialize metódusokat.Deserialize

Az XML-sémadefiníciós eszköz (Xsd.exe) időnként létrehozza az XmlIgnoreAttribute osztályokat egy sémafájlból (.xsd). Ez a viselkedés azért fordul elő, mert az értéktípusok nem állíthatók be null, de minden XML-adattípus lehet. Ezért az eszköz két mezőt hoz létre, amikor olyan XML-típussal találkozik, amely egy értéktípusra van leképezve: az egyik az érték tárolására, a másik pedig a mező vagy tulajdonság nevére cserélt speciális mezőfieldnameSpecifiedfieldname. Figyelje meg azonban, hogy ez a speciális mező csak akkor jön létre, ha a séma azt határozza meg, hogy az elemnek nincs minimális előfordulása (minOccurs = "0"), és hogy az elemnek nincs alapértelmezett értéke. A XmlSerializer speciális mező beállítása és ellenőrzése annak megállapításához, hogy a mező vagy tulajdonság értéke be van-e állítva. Mivel a speciális mezőt nem szabad szerializálni, az eszköz alkalmazza rá.XmlIgnoreAttribute

Az attribútumok használatáról további információt az Attribútumok című témakörben talál.

Note

A hosszabb helyett használhatja a szót XmlIgnore a XmlIgnoreAttributekódban.

Konstruktorok

Name	Description
XmlIgnoreAttribute()	Inicializálja a XmlIgnoreAttribute osztály új példányát.

Tulajdonságok

Name	Description
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)

Metódusok

Name	Description
Equals(Object)	Olyan értéket ad vissza, amely jelzi, hogy ez a példány egyenlő-e egy adott objektummal. (Öröklődés forrása Attribute)
GetHashCode()	A példány kivonatkódját adja vissza. (Öröklődés forrása Attribute)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Ha egy származtatott osztályban felül van bírálva, azt jelzi, hogy a példány értéke-e a származtatott osztály alapértelmezett értéke. (Öröklődés forrása Attribute)
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Lásd még

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• Az XML-szerializálás bemutatása
• Útmutató: Alternatív elemnév megadása XML-adatfolyamhoz
• XML-szerializálás szabályozása attribútumokkal
• Példák XML-szerializálásra
• XML-sémadefiníciós eszköz (Xsd.exe)