XmlIgnoreAttribute Classe

Referência

Definição

Namespace:: System.Xml.Serialization

Assembly:: System.Xml.XmlSerializer.dll

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

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.

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

Herança: Object

Attribute
XmlIgnoreAttribute

Atributos: AttributeUsageAttribute

Exemplos

O exemplo a seguir mostra uma classe chamada Group, que contém um campo chamado Comment. O exemplo atribui o XmlIgnoreAttribute campo, instruindo assim a XmlSerializer ignorar o campo ao serializar ou desserializar uma instância da 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

Comentários

Pertence XmlIgnoreAttribute a uma família de atributos que controla como o XmlSerializer serializa ou desserializa um objeto. Se você aplicar a XmlIgnoreAttribute qualquer membro de uma classe, o XmlSerializer membro ignorará ao serializar ou desserializar uma instância da classe. Para obter uma lista completa de atributos semelhantes, consulte Atributos que controlam a serialização XML.

Você pode substituir o comportamento causado pela XmlIgnoreAttribute criação de um XmlAttributes objeto e definir sua XmlIgnore propriedade como false. Você deve Add o XmlAttributes objeto para uma instância da XmlAttributeOverrides classe. Por fim, você deve usar o XmlAttributeOverrides objeto para construir uma instância da XmlSerializer classe antes de chamar os métodos ou Deserialize os Serialize métodos.

A Ferramenta de Definição de Esquema XML (Xsd.exe) gera ocasionalmente ao XmlIgnoreAttribute criar classes de um arquivo de esquema (.xsd). Esse comportamento ocorre porque os tipos de valor não podem ser definidos como null, mas todos os tipos de dados XML podem ser. 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 de fieldnameSpecified, em que o fieldname é substituído pelo nome do campo ou propriedade. No entanto, observe 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 nenhum valor padrão. Os XmlSerializer conjuntos e verifica esse campo especial para determinar se um valor foi definido para o campo ou propriedade. Como o campo especial não deve ser serializado, a ferramenta aplica-se XmlIgnoreAttribute a ele.

Para obter mais informações sobre como usar atributos, consulte Atributos.

Observação

Você pode usar a palavra XmlIgnore em seu código em vez de mais tempo XmlIgnoreAttribute.

Construtores

XmlIgnoreAttribute()

Inicializa uma nova instância da classe XmlIgnoreAttribute.

Propriedades

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.

(Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Implantações explícitas de interface

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição. (Herdado de Attribute)
_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. (Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1). (Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fornece acesso a propriedades e métodos expostos por um objeto. (Herdado de Attribute)

Aplica-se a

Partilhar via