XmlIgnoreAttribute Classe

Definizione

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à

Object

Attribute

XmlIgnoreAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene illustrata una classe denominata , che contiene un campo denominato GroupComment. L'esempio assegna l'oggetto al campo, in modo da indicare all'utente XmlIgnoreAttributeXmlSerializer di ignorare il campo durante la serializzazione o la deserializzazione di un'istanza della classe.

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

Commenti

Appartiene XmlIgnoreAttribute a una famiglia di attributi che controlla la modalità XmlSerializer di serializzazione o deserializza un oggetto. Se si applica l'oggetto XmlIgnoreAttribute a qualsiasi membro di una classe, il XmlSerializer membro viene ignorato 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 impostare la relativa XmlIgnore proprietà su false. È necessario Add usare l'oggetto in un'istanza XmlAttributes della XmlAttributeOverrides classe. Infine, è necessario usare l'oggetto per costruire un'istanza XmlAttributeOverrides della XmlSerializer classe prima di chiamare i Serialize metodi o Deserialize .

Lo strumento di definizione xml Schema (Xsd.exe) genera occasionalmente le classi durante la XmlIgnoreAttribute creazione di classi da un file di schema (con estensione xsd). Questo comportamento si verifica perché i tipi di 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 accetta 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 alcuna occorrenza minima (minOccurs = "0") e che l'elemento non ha valore predefinito. I XmlSerializer set e controllano 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 si applica a XmlIgnoreAttribute esso.

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

Costruttori

Proprietà

Metodi

Implementazioni dell'interfaccia esplicita

Si applica a

Vedi anche

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• Introduzione alla serializzazione XML
• Procedura: specificare un nome di elemento alternativo per un flusso XML
• Controllo della serializzazione XML mediante attributi
• Esempi di serializzazione XML
• Strumento di definizione xml Schema (Xsd.exe)