XmlIgnoreAttribute Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Instruerar metoden Serialize(TextWriter, Object) för att inte serialisera det offentliga fältet eller egenskapsvärdet XmlSerializer för offentlig läsning/skrivning.
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 AttributePublic Class XmlIgnoreAttribute
Inherits Attribute- Arv
- Attribut
Exempel
I följande exempel visas en klass med namnet Group, som innehåller ett fält med namnet Comment. Exemplet tilldelar XmlIgnoreAttribute fältet, vilket instruerar XmlSerializer att ignorera fältet vid serialisering eller deserialisering av en instans av klassen.
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
Kommentarer
XmlIgnoreAttribute Tillhör en familj av attribut som styr hur XmlSerializer serialiserar eller deserialiserar ett objekt. Om du tillämpar på XmlIgnoreAttribute någon medlem i en klass XmlSerializer ignoreras medlemmen när du serialiserar eller deserialiserar en instans av klassen. En fullständig lista över liknande attribut finns i Attribut som styr XML-serialisering.
Du kan åsidosätta beteendet som orsakas av XmlIgnoreAttribute att skapa ett XmlAttributes objekt och ange dess XmlIgnore egenskap till false. Du måste Add objektet XmlAttributes till en instans av XmlAttributeOverrides klassen. Slutligen måste du använda XmlAttributeOverrides objektet för att konstruera en instans av XmlSerializer klassen innan du anropar Serialize metoderna eller Deserialize .
XML-schemadefinitionsverktyget (Xsd.exe) genererar XmlIgnoreAttribute ibland när du skapar klasser från en schemafil (.xsd). Det här beteendet beror på att värdetyper inte kan anges till null, men alla XML-datatyper kan vara det. Därför skapar verktyget två fält när det stöter på en XML-typ som mappar till en värdetyp: ett för att lagra värdet och ett annat specialfält som har formen fieldnameSpecified, där fieldname ersätts med namnet på fältet eller egenskapen. Observera dock att det här specialfältet endast genereras när schemat anger att elementet inte har någon minsta förekomst (minOccurs = "0") och att elementet inte har något standardvärde. Anger XmlSerializer och kontrollerar det här specialfältet för att avgöra om ett värde har angetts för fältet eller egenskapen. Eftersom specialfältet inte får serialiseras XmlIgnoreAttribute gäller verktyget för det.
Mer information om hur du använder attribut finns i Attribut.
Note
Du kan använda ordet XmlIgnore i koden i stället för längre XmlIgnoreAttribute.
Konstruktorer
| Name | Description |
|---|---|
| XmlIgnoreAttribute() |
Initierar en ny instans av XmlIgnoreAttribute klassen. |
Egenskaper
| Name | Description |
|---|---|
| TypeId |
När den implementeras i en härledd klass hämtar du en unik identifierare för den här Attribute. (Ärvd från Attribute) |
Metoder
| Name | Description |
|---|---|
| Equals(Object) |
Returnerar ett värde som anger om den här instansen är lika med ett angivet objekt. (Ärvd från Attribute) |
| GetHashCode() |
Returnerar hash-koden för den här instansen. (Ärvd från Attribute) |
| GetType() |
Hämtar den aktuella instansen Type . (Ärvd från Object) |
| IsDefaultAttribute() |
När den åsidosättas i en härledd klass anger du om värdet för den här instansen är standardvärdet för den härledda klassen. (Ärvd från Attribute) |
| Match(Object) |
När den åsidosätts i en härledd klass returneras ett värde som anger om den här instansen är lika med ett angivet objekt. (Ärvd från Attribute) |
| MemberwiseClone() |
Skapar en ytlig kopia av den aktuella Object. (Ärvd från Object) |
| ToString() |
Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Object) |
Explicita gränssnittsimplementeringar
| Name | Description |
|---|---|
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Mappar en uppsättning namn till en motsvarande uppsättning av sändningsidentifierare. (Ärvd från Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Hämtar typinformationen för ett objekt, som kan användas för att hämta typinformationen för ett gränssnitt. (Ärvd från Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Hämtar antalet typinformationsgränssnitt som ett objekt tillhandahåller (antingen 0 eller 1). (Ärvd från Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Ger åtkomst till egenskaper och metoder som exponeras av ett objekt. (Ärvd från Attribute) |
