XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute Class

Definizione

Fa in modo che il metodo Serialize(TextWriter, Object) di XmlSerializer non serializzi il campo pubblico o il valore pubblico della proprietà in lettura/scrittura.Instructs the Serialize(TextWriter, Object) method of the XmlSerializer not to serialize the public field or public read/write property value.

public ref class XmlIgnoreAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute
type XmlIgnoreAttribute = class
    inherit Attribute
Public Class XmlIgnoreAttribute
Inherits Attribute
Ereditarietà
XmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttribute
Attributi

Esempi

Nell'esempio seguente viene illustrata una classe denominata Group, che contiene un campo denominato Comment.The following example shows a class named Group, which contains a field named Comment. Nell'esempio viene assegnato il XmlIgnoreAttribute campo, facendo in modo che il XmlSerializer per ignorare il campo durante la serializzazione o deserializzazione di un'istanza della classe.The example assigns the XmlIgnoreAttribute to the field, thereby instructing the XmlSerializer to ignore the field when serializing or deserializing an instance of the class.

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

Il XmlIgnoreAttribute appartiene a una famiglia di attributi che controlla come il XmlSerializer serializza o deserializza un oggetto.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Se si applica il XmlIgnoreAttribute a qualsiasi membro di una classe, il XmlSerializer ignora il membro quando si serializza o deserializza un'istanza della classe.If you apply the XmlIgnoreAttribute to any member of a class, the XmlSerializer ignores the member when serializing or deserializing an instance of the class. Per un elenco completo degli attributi simili, vedere gli attributi che controllano la serializzazione XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

È possibile eseguire l'override del comportamento causato dai XmlIgnoreAttribute creando un XmlAttributes oggetto e impostazione relativo XmlIgnore proprietà false.You can override the behavior caused by the XmlIgnoreAttribute by creating an XmlAttributes object, and setting its XmlIgnore property to false. È necessario Add il XmlAttributes a un'istanza di oggetto di XmlAttributeOverrides classe.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. Infine, è necessario usare il XmlAttributeOverrides per costruire un'istanza dell'oggetto di XmlSerializer classe prima di chiamare il Serialize o Deserialize metodi.Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

Il strumento XML Schema Definition (Xsd.exe.) occasionalmente genera il XmlIgnoreAttribute durante la creazione di classi da un file di schema (XSD).The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlIgnoreAttribute when creating classes from a schema file (.xsd). Questo comportamento si verifica perché i tipi di valore non possono essere impostati su null, ma possono essere tutti i tipi di dati XML.This behavior occurs because value types cannot be set to null, but all XML data types can be. Pertanto, lo strumento crea due campi quando viene rilevato un tipo XML che viene eseguito il mapping a un tipo valore: uno per contenere il valore e un altro campo speciale che assume la forma fieldnameSpecified, dove il fieldname viene sostituito dal nome del campo o della proprietà.Therefore, the tool creates two fields when it encounters an XML type that maps to a value type: one to hold the value and another special field that takes the form of fieldnameSpecified, where the fieldname is replaced by the name of the field or property. Si noti, tuttavia, questo campo speciale viene generato solo quando lo schema specifica che l'elemento non dispone di alcuna occorrenza minimo (minOccurs = "0") e che l'elemento non dispone di alcun valore predefinito.Notice, however, that this special field is generated only when the schema specifies that the element has no minimum occurrence (minOccurs = "0") and that the element has no default value. Il XmlSerializer impostato e viene controllato il campo speciale per determinare se è stato impostato un valore per il campo o proprietà.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. Poiché il campo speciale non deve essere serializzato, viene applicato lo strumento di XmlIgnoreAttribute ad esso.Because the special field must not be serialized, the tool applies the XmlIgnoreAttribute to it.

Per altre informazioni sull'utilizzo di attributi, vedere attributi.For more information about using attributes, see Attributes.

Nota

È possibile usare la parola XmlIgnore nel codice anziché la forma estesa XmlIgnoreAttribute.You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Costruttori

XmlIgnoreAttribute() XmlIgnoreAttribute() XmlIgnoreAttribute() XmlIgnoreAttribute()

Inizializza una nuova istanza della classe XmlIgnoreAttribute.Initializes a new instance of the XmlIgnoreAttribute class.

Metodi

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Restituisce il codice hash per l'istanza.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Implementazioni dell'interfaccia esplicita

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

Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera le informazioni sul tipo relative a un oggetto, che possono essere usate per ottenere informazioni sul tipo relative a un'interfaccia.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornisce l'accesso a proprietà e metodi esposti da un oggetto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Proprietà

TypeId TypeId TypeId TypeId

Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Si applica a

Vedi anche