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 seguinte mostra uma classe chamada Group, que contém um corpo chamado Comment. O exemplo atribui o XmlIgnoreAttribute ao corpo, instruindo assim o XmlSerializer a ignorar o corpo 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

Observações

Pertence XmlIgnoreAttribute a uma família de atributos que controla como serializa XmlSerializer ou desserializa um objeto. Se aplicares o XmlIgnoreAttribute a qualquer membro de uma classe, ignora XmlSerializer o membro 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.

Pode sobrepor o comportamento causado pelo XmlIgnoreAttribute ao criar um XmlAttributes objeto e definir a sua XmlIgnore propriedade para false. Deve Add ser o XmlAttributes objeto de uma instância da XmlAttributeOverrides classe. Por fim, deve usar o XmlAttributeOverrides objeto para construir uma instância da XmlSerializer classe antes de chamar os Serialize métodos ou Deserialize .

A Ferramenta de Definição de Esquemas XML (Xsd.exe) ocasionalmente gera o XmlIgnoreAttribute ao criar classes a partir de um ficheiro de esquema (.xsd). Este comportamento ocorre porque os tipos de valor não podem ser definidos para null, mas todos os tipos de dados XML podem ser. Assim, a ferramenta cria dois campos quando encontra um tipo XML que corresponde a um tipo de valor: um para guardar o valor e outro campo especial que assume a forma de fieldnameSpecified, onde o fieldname é substituído pelo nome do campo ou propriedade. Note-se, no entanto, que este campo especial só é gerado quando o esquema especifica que o elemento não tem ocorrência mínima (minOccurs = "0") e que o elemento não tem valor por defeito. O XmlSerializer sistema define e verifica este campo especial para determinar se um valor foi definido para o campo ou propriedade. Como o campo especial não pode ser serializado, a ferramenta aplica-lhe o XmlIgnoreAttribute .

Para mais informações sobre o uso de atributos, consulte Atributos.

Ver também

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• Apresentando a 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)