XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute XmlIgnoreAttribute Class

Definição

Instrui o método Serialize(TextWriter, Object) do XmlSerializer para não serializar o campo público ou o valor da propriedade pública de leitura/gravação.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
Herança
XmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttributeXmlIgnoreAttribute
Atributos

Exemplos

O exemplo a seguir mostra uma classe Groupchamada, que contém um campo Commentchamado.The following example shows a class named Group, which contains a field named Comment. O exemplo atribui o XmlIgnoreAttribute ao campo, instruindo, assim, o XmlSerializer a ignorar o campo ao serializar ou desserializar uma instância da 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

Comentários

O XmlIgnoreAttribute pertence a uma família de atributos que controla como o XmlSerializer serializa ou desserializa um objeto.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Se você aplicar o XmlIgnoreAttribute a qualquer membro de uma classe, o XmlSerializer ignorará o membro ao serializar ou desserializar uma instância da 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. Para obter uma lista completa de atributos semelhantes, consulte atributos que controlam a serialização de XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Você pode substituir o XmlIgnoreAttribute comportamento causado pelo criando um XmlAttributes objeto e definindo sua XmlIgnore Propriedade como false.You can override the behavior caused by the XmlIgnoreAttribute by creating an XmlAttributes object, and setting its XmlIgnore property to false. Você deve Add ter XmlAttributes o objeto XmlAttributeOverrides em uma instância da classe.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. Por fim, você deve usar o XmlAttributeOverrides objeto para construir uma instância XmlSerializer da classe antes de chamar os Serialize métodos ou Deserialize .Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

A ferramenta de definição de esquema XML (XSD. exe) eventualmente XmlIgnoreAttribute gera o ao criar classes a partir de um arquivo de esquema (. xsd).The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlIgnoreAttribute when creating classes from a schema file (.xsd). Esse comportamento ocorre porque os tipos de valor não podem nullser definidos como, mas todos os tipos de dados XML podem ser.This behavior occurs because value types cannot be set to null, but all XML data types can be. Portanto, a ferramenta cria dois campos quando encontra um tipo XML que é mapeado para um tipo de valor: um para manter o valor e outro campo especial que assume a forma fieldnameSpecifiedde, em fieldname que o é substituído pelo nome do campo ou da propriedade.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. Observe, no entanto, que esse campo especial é gerado somente quando o esquema especifica que o elemento não tem nenhuma ocorrência mínima (minOccurs = "0") e que o elemento não tem valor padrão.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. O XmlSerializer define e verifica este campo especial para determinar se um valor foi definido para o campo ou a propriedade.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. Como o campo especial não deve ser serializado, a ferramenta aplica o XmlIgnoreAttribute a ele.Because the special field must not be serialized, the tool applies the XmlIgnoreAttribute to it.

Para obter mais informações sobre como usar atributos, consulte atributos.For more information about using attributes, see Attributes.

Observação

Você pode usar a palavra XmlIgnore em seu código em vez de mais XmlIgnoreAttributelonga.You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

Construtores

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

Inicializa uma nova instância da classe XmlIgnoreAttribute.Initializes a new instance of the XmlIgnoreAttribute class.

Métodos

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

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

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

Retorna o código hash para essa instância.Returns the hash code for this instance.

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

Obtém o Type da instância atual.Gets the Type of the current instance.

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

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.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 substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.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()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

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

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Inherited from Object)

Implantações explícitas de interface

_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)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.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 as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.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)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 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)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Propriedades

TypeId TypeId TypeId TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Aplica-se a

Veja também