XmlAnyElementAttribute Classe

Definição

public ref class XmlAnyElementAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=true)]
public class XmlAnyElementAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=true)>]
type XmlAnyElementAttribute = class
    inherit Attribute

Public Class XmlAnyElementAttribute
Inherits Attribute

Herança

Object

Attribute

XmlAnyElementAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo seguinte aplica-se a XmlAnyElementAttribute um campo nomeado AllElements que devolve um array de XmlElement objetos.

public class XClass
{
   /* Apply the XmlAnyElementAttribute to a field returning an array
   of XmlElement objects. */
   [XmlAnyElement]
   public XmlElement[] AllElements;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.DeserializeObject("XFile.xml");
   }

   private void DeserializeObject(string filename)
   {
      // Create an XmlSerializer.
      XmlSerializer mySerializer = new XmlSerializer(typeof(XClass));

      // To read a file, a FileStream is needed.
      FileStream fs = new FileStream(filename, FileMode.Open);

      // Deserialize the class.
      XClass x = (XClass) mySerializer.Deserialize(fs);

      // Read the element names and values.
      foreach(XmlElement xel in x.AllElements)
         Console.WriteLine(xel.LocalName + ": " + xel.Value);
   }
}

Public Class XClass
    ' Apply the XmlAnyElementAttribute to a field returning an array
    ' of XmlElement objects.
    <XmlAnyElement()> Public AllElements() As XmlElement
End Class


Public Class Test
    
    Public Shared Sub Main()
        Dim t As New Test()
        t.DeserializeObject("XFile.xml")
    End Sub
    
    
    Private Sub DeserializeObject(filename As String)
        ' Create an XmlSerializer.
        Dim mySerializer As New XmlSerializer(GetType(XClass))
        
        ' To read a file, a FileStream is needed.
        Dim fs As New FileStream(filename, FileMode.Open)
        
        ' Deserialize the class.
        Dim x As XClass = CType(mySerializer.Deserialize(fs), XClass)
        
        ' Read the element names and values.
        Dim xel As XmlElement
        For Each xel In  x.AllElements
            Console.WriteLine((xel.LocalName & ": " & xel.Value))
        Next xel
    End Sub
End Class

Observações

Use o XmlAnyElementAttribute para conter dados arbitrários (como elementos XML) que podem ser enviados como parte de um documento XML, como metadados enviados como parte do documento.

Aplicar o XmlAnyElementAttribute a um campo que devolve um array de XmlElement ou XmlNode objetos. Tal campo pode ser usado de duas formas, dependendo se um objeto está a ser serializado ou desserializado. Quando serializado, o objeto é gerado como elementos ou nós XML, mesmo que não tenham nenhum membro correspondente (ou membros) no objeto a ser serializado. Se especificar um Name valor de propriedade ao aplicar o atributo, todos XmlElement os XmlNode objetos inseridos no array devem ter o mesmo nome de elemento e namespace por defeito, caso contrário é lançada uma exceção. Se definires o valor da Namespace propriedade, também tens de definir a Name propriedade, e os XmlElement objetos ou XmlNode também devem ter os mesmos valores de nome e espaço de nomes. Se não for especificado um Name valor, os XmlElement objetos ou XmlNode podem ter qualquer nome de elemento.

Quando se chama o Deserialize método da XmlSerializer classe, todos os elementos que não têm um membro correspondente no objeto a desserializar são recolhidos no array. Após a desserialização, itere pela recolha de XmlElement itens para processar os dados. Se especificar um Name valor, o array contém apenas elementos XML com esse nome. Se não especificar um Name valor, o array contém todos os elementos que não têm um membro correspondente na classe. Se uma classe contiver mais do que um campo ao qual o atributo é aplicado, use as Namepropriedades , ou Name e Namespace para diferenciar o conteúdo dos arrays. Se tal classe (com múltiplos campos) também contiver um campo que não tenha valores de propriedades diferenciadoras definidos (ou seja, Name e Namespace) durante a desserialização, este array contém quaisquer elementos XML desconhecidos que não estejam já contidos nos outros arrays. Se uma classe contiver mais do que um campo que não tenha um conjunto de valores diferenciador Name, ou Name um Namespace conjunto, o comportamento durante a desserialização não é especificado.

Também podes aplicar o XmlAnyElementAttribute a um campo que devolve um único XmlElement objeto. Se o fizer, deve usar as propriedades e métodos da XmlElement classe para iterar recursivamente pelos elementos desconhecidos.

Pode aplicar múltiplas instâncias do XmlAnyElementAttribute a um membro da classe, mas cada instância deve ter um valor de propriedade distinto Name . Ou, se a mesma Name propriedade for definida para cada instância, deve ser definido um valor distinto Namespace para cada instância.

Os UnknownNode eventos UnknownAttribute e não XmlSerializer ocorrem se aplicares a XmlAnyElementAttribute um membro de uma classe.

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

Ver também

• XmlAnyAttributeAttribute
• Apresentando a serialização XML