Condividi tramite


XmlIgnoreAttribute Classe

Definizione

Indica al metodo Serialize(TextWriter, Object) del XmlSerializer di non serializzare il valore della proprietà pubblica o di lettura/scrittura pubblica.

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
Ereditarietà
XmlIgnoreAttribute
Attributi

Esempio

Nell'esempio seguente viene illustrata una classe denominata Group, che contiene un campo denominato Comment. Nell'esempio viene assegnato l'oggetto XmlIgnoreAttribute al campo , in modo da indicare XmlSerializer a di ignorare il campo durante la serializzazione o la deserializzazione di un'istanza della classe .

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

Commenti

Appartiene XmlIgnoreAttribute a una famiglia di attributi che controlla la XmlSerializer modalità di serializzazione o deserializzazione di un oggetto. Se si applica a XmlIgnoreAttribute un membro di una classe, il XmlSerializer ignora il membro durante la serializzazione o la deserializzazione di un'istanza della classe . Per un elenco completo di attributi simili, vedere Attributi che controllano la serializzazione XML.

È possibile eseguire l'override XmlIgnoreAttribute del comportamento causato dalla creazione di un XmlAttributes oggetto e impostarne la XmlIgnore proprietà su false. È necessario Add l'oggetto a un'istanza XmlAttributes della XmlAttributeOverrides classe . Infine, è necessario utilizzare l'oggetto per costruire un'istanza XmlAttributeOverrides della XmlSerializer classe prima di chiamare i Serialize metodi o Deserialize .

Lo strumento di definizione dello schema XML (Xsd.exe) genera occasionalmente l'oggetto durante la XmlIgnoreAttribute creazione di classi da un file di schema (con estensione xsd). Questo comportamento si verifica perché i tipi valore non possono essere impostati su null, ma tutti i tipi di dati XML possono essere. Pertanto, lo strumento crea due campi quando rileva un tipo XML che esegue il mapping a un tipo di valore: uno per contenere il valore e un altro campo speciale che assume la forma di fieldnameSpecified, dove viene fieldname sostituito dal nome del campo o della proprietà. Si noti, tuttavia, che questo campo speciale viene generato solo quando lo schema specifica che l'elemento non ha occorrenza minima (minOccurs = "0") e che l'elemento non ha alcun valore predefinito. Imposta XmlSerializer e controlla questo campo speciale per determinare se è stato impostato un valore per il campo o la proprietà. Poiché il campo speciale non deve essere serializzato, lo strumento applica a XmlIgnoreAttribute esso.

Per altre informazioni sull'uso degli attributi, vedere Attributi.

Annotazioni

È possibile usare la parola XmlIgnore nel codice anziché quella più lunga XmlIgnoreAttribute.

Costruttori

Nome Descrizione
XmlIgnoreAttribute()

Inizializza una nuova istanza della classe XmlIgnoreAttribute.

Proprietà

Nome Descrizione
TypeId

Se implementato in una classe derivata, ottiene un identificatore univoco per questo Attribute.

(Ereditato da Attribute)

Metodi

Nome Descrizione
Equals(Object)

Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato.

(Ereditato da Attribute)
GetHashCode()

Restituisce il codice hash per questa istanza.

(Ereditato da Attribute)
GetType()

Ottiene il Type dell'istanza corrente.

(Ereditato da Object)
IsDefaultAttribute()

Quando sottoposto a override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata.

(Ereditato da Attribute)
Match(Object)

Quando sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza è uguale a un oggetto specificato.

(Ereditato da Attribute)
MemberwiseClone()

Crea una copia superficiale del Objectcorrente.

(Ereditato da Object)
ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)

Implementazioni dell'interfaccia esplicita

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

Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch.

(Ereditato da Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera le informazioni sul tipo per un oggetto, che può essere utilizzato per ottenere le informazioni sul tipo per un'interfaccia.

(Ereditato da Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 1).

(Ereditato da Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornisce l'accesso alle proprietà e ai metodi esposti da un oggetto .

(Ereditato da Attribute)

Si applica a

Vedi anche