XmlIgnoreAttribute Classe

Definiçã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 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 classe antes de XmlSerializer chamar os Serialize métodos.Deserialize

A Ferramenta de Definição de Esquema XML (Xsd.exe) ocasionalmente gera ao XmlIgnoreAttribute criar classes de um arquivo de esquema (.xsd). Esse comportamento ocorre porque os tipos de valor não podem ser definidos null, mas todos os tipos de dados XML podem ser. Portanto, a ferramenta cria dois campos quando encontra um tipo XML que mapeia 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 a 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.

Confira também

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• Introdução à serialização XML
• Como especificar um nome de elemento alternativo para um fluxo XML
• Controlando a serialização XML usando atributos
• Exemplos de serialização XML
• Ferramenta de Definição de Esquema XML (Xsd.exe)