XmlAnyElementAttribute Classe

Definição

Especifica que o membro (um campo que retorna uma matriz de objetos XmlElement ou XmlNode) contém objetos que representam qualquer elemento XML que não tem nenhum membro correspondente no objeto que está sendo serializado ou desserializado.Specifies that the member (a field that returns an array of XmlElement or XmlNode objects) contains objects that represent any XML element that has no corresponding member in the object being serialized or deserialized.

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
type XmlAnyElementAttribute = class
    inherit Attribute
Public Class XmlAnyElementAttribute
Inherits Attribute
Herança
XmlAnyElementAttribute
Atributos

Exemplos

O exemplo a seguir aplica XmlAnyElementAttribute a a um campo AllElements chamado que retorna uma matriz XmlElement de objetos.The following example applies the XmlAnyElementAttribute to a field named AllElements that returns an array of XmlElement objects.

public ref class XClass
{
public:

   /* Apply the XmlAnyElementAttribute to a field returning an array
      of XmlElement objects. */

   [XmlAnyElement]
   array<XmlElement^>^AllElements;
};

public ref class Test
{
public:
   void DeserializeObject( String^ filename )
   {
      // Create an XmlSerializer.
      XmlSerializer^ mySerializer = gcnew XmlSerializer( XClass::typeid );

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

      // Deserialize the class.
      XClass^ x = dynamic_cast<XClass^>(mySerializer->Deserialize( fs ));

      // Read the element names and values.
      System::Collections::IEnumerator^ myEnum = x->AllElements->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         XmlElement^ xel = safe_cast<XmlElement^>(myEnum->Current);
         Console::WriteLine( "{0}: {1}", xel->LocalName, xel->Value );
      }
   }
};

int main()
{
   Test^ t = gcnew Test;
   t->DeserializeObject( "XFile.xml" );
}
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

Comentários

Dica

Ao trabalhar em uma biblioteca de classes portátil, como no Silverlight, Windows Phone ou projeto de aplicativo da Windows Store, e você estiver usando o .NET Framework 4.0.3 e superior XElement , XNode use ou no XmlElement lugar XmlNodedo e do.When working in a portable class library, such as in Silverlight, Windows Phone or Windows Store App project, and you are using the .NET Framework 4.0.3 and above, use XElement or XNode in place of XmlElement and XmlNode.

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.Use the XmlAnyElementAttribute to contain arbitrary data (as XML elements) that can be sent as part of an XML document, such as metadata sent as part of the document.

Aplique o XmlAnyElementAttribute a um campo que retorna uma matriz de XmlElement objetos XmlNode ou.Apply the XmlAnyElementAttribute to a field that returns an array of XmlElement or XmlNode objects. Esse campo pode ser usado de duas maneiras, dependendo se um objeto está sendo serializado ou desserializado.Such a field can be used in two ways, depending on whether an object is being serialized or deserialized. Quando serializado, o objeto é gerado como elementos XML ou nós, mesmo que não tenha nenhum membro (ou membros) correspondente no objeto que está sendo serializado.When serialized, the object is generated as XML elements or nodes, even though they have no corresponding member (or members) in the object being serialized. Se você especificar um Name valor de propriedade ao aplicar o atributo, XmlElement todos XmlNode os objetos ou inseridos na matriz deverão ter o mesmo nome de elemento e namespace padrão, ou uma exceção será lançada.If you specify a Name property value when applying the attribute, all XmlElement or XmlNode objects inserted into the array must have the same element name and default namespace, or an exception is thrown. Se você definir o Namespace valor da propriedade, também deverá definir Name a propriedade, e os XmlElement objetos ou XmlNode deverão ter os mesmos valores de nome e namespace.If you set the Namespace property value, you must set the Name property as well, and the XmlElement or XmlNode objects must also have the same name and namespace values. Se nenhum Name valor for especificado, os XmlElement objetos XmlNode ou poderão ter qualquer nome de elemento.If no Name value is specified, the XmlElement or XmlNode objects can have any element name.

Quando você chama o Deserialize método XmlSerializer da classe, todos os elementos que não têm um membro correspondente no objeto que está sendo desserializado são coletados na matriz.When you call the Deserialize method of the XmlSerializer class, all elements that do not have a corresponding member in the object being deserialized are collected in the array. Após a desserialização, itere a coleção XmlElement de itens para processar os dados.After deserialization, iterate through the collection of XmlElement items to process the data. Se você especificar um Name valor, a matriz conterá apenas elementos XML com esse nome.If you specify a Name value, the array contains only XML elements with that name. Se você não especificar um Name valor, a matriz conterá todos os elementos que não têm nenhum membro correspondente na classe.If you do not specify a Name value, the array contains all elements that have no corresponding member in the class. Se uma classe contiver mais de um campo ao qual o atributo é aplicado, use Nameas propriedades Name , Namespace ou e para diferenciar entre o conteúdo das matrizes.If a class contains more than one field to which the attribute is applied, use the Name, or Name and Namespace properties to differentiate between the contents of the arrays. Se tal classe (com vários campos) também contiver um campo que não tenha valores de propriedade diferenciados definidos (em outras palavras Name , Namespacee) durante a desserialização, essa matriz conterá quaisquer elementos XML desconhecidos que ainda não estejam contidos nas outras matrizes.If such a class (with multiple fields) also contains one field that has no differentiating property values set (in other words, Name and Namespace) during deserialization, this array contains any unknown XML elements that are not already contained in the other arrays. Se uma classe contiver mais de um campo que não tenha uma diferenciação Name, ou Name e Namespace valor definido, o comportamento durante a desserialização não será especificado.If a class contains more than one field that does not have a differentiating Name, or Name and Namespace value set, the behavior during deserialization is unspecified.

Você também pode aplicar o XmlAnyElementAttribute a um campo que retorna um único XmlElement objeto.You can also apply the XmlAnyElementAttribute to a field that returns a single XmlElement object. Se você fizer isso, deverá usar as propriedades e os métodos da XmlElement classe para iterar recursivamente por meio dos elementos desconhecidos.If you do so, you must use the properties and methods of the XmlElement class to recursively iterate through the unknown elements.

Você pode aplicar várias instâncias do XmlAnyElementAttribute a um membro de classe, mas cada instância deve ter um valor de propriedade distinta. NameYou can apply multiple instances of the XmlAnyElementAttribute to a class member, but each instance must have a distinct Name property value. Ou, se a mesma Name propriedade for definida para cada instância, um valor Namespace de propriedade DISTINCT deverá ser definido para cada instância.Or, if the same Name property is set for each instance, a distinct Namespace property value must be set for each instance.

Os UnknownNode eventos UnknownAttribute e XmlAnyElementAttribute de XmlSerializer não ocorrem se você aplicar o a um membro de uma classe.The UnknownNode and UnknownAttribute events of the XmlSerializer do not occur if you apply the XmlAnyElementAttribute to a member of a class.

Observação

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

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

Construtores

XmlAnyElementAttribute()

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

XmlAnyElementAttribute(String)

Inicializa uma nova instância da classe XmlAnyElementAttribute e especifica o nome do elemento XML gerado no documento XML.Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document.

XmlAnyElementAttribute(String, String)

Inicializa uma nova instância da classe XmlAnyElementAttribute e especifica o nome do elemento XML gerado no documento XML e seu namespace de XML.Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document and its XML namespace.

Propriedades

Name

Obtém ou define o nome do elemento XML.Gets or sets the XML element name.

Namespace

Obtém ou define o namespace de XML gerado no documento XML.Gets or sets the XML namespace generated in the XML document.

Order

Obtém ou define a ordem explícita na qual os elementos são serializados ou desserializados.Gets or sets the explicit order in which the elements are serialized or deserialized.

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.

(Herdado de Attribute)

Métodos

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.

(Herdado de Attribute)
GetHashCode()

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

(Herdado de Attribute)
GetType()

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

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

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

(Herdado de Object)
ToString()

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

(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.Maps a set of names to a corresponding set of dispatch identifiers.

(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.Retrieves the type information for an object, which can be used to get the type information for an 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).Retrieves the number of type information interfaces that an object provides (either 0 or 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.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Veja também