XmlAnyElementAttribute XmlAnyElementAttribute XmlAnyElementAttribute XmlAnyElementAttribute Class

Definición

Especifica que el miembro (un campo que devuelve una matriz de objetos XmlElement o XmlNode) contiene objetos que representan los elementos XLM que no tienen un miembro correspondiente en el objeto que se está serializando o deserializando.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
Herencia
XmlAnyElementAttributeXmlAnyElementAttributeXmlAnyElementAttributeXmlAnyElementAttribute
Atributos

Ejemplos

XmlAnyElementAttribute En el ejemplo siguiente se aplica a un campo AllElements denominado que devuelve una 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

Comentarios

Sugerencia

Al trabajar en una biblioteca de clases portable, como en Silverlight, Windows Phone o un proyecto de aplicación de la tienda Windows, y usa el .NET Framework 4.0.3 y versiones XElement posteriores XNode , use o XmlElement en XmlNodelugar de y.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.

XmlAnyElementAttribute Utilice para que contenga datos arbitrarios (como elementos XML) que se puedan enviar como parte de un documento XML, como los metadatos enviados como parte del 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 a un campo que devuelve una matriz de XmlElement objetos o XmlNode. XmlAnyElementAttributeApply the XmlAnyElementAttribute to a field that returns an array of XmlElement or XmlNode objects. Este tipo de campo se puede utilizar de dos maneras, en función de si un objeto se está serializando o deserializando.Such a field can be used in two ways, depending on whether an object is being serialized or deserialized. Cuando se serializa, el objeto se genera como elementos o nodos XML, aunque no tengan ningún miembro (o miembros) correspondiente en el objeto que se está serializando.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. Si especifica un Name valor de propiedad al aplicar el atributo, todos XmlElement los XmlNode objetos o insertados en la matriz deben tener el mismo nombre de elemento y espacio de nombres predeterminado, o se produce una excepción.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. Si establece el valor Namespace de la propiedad, debe establecer también Name la propiedad, y los XmlElement objetos o XmlNode también deben tener el mismo nombre y los mismos valores de espacio de nombres.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. Si no Name se especifica ningún valor, XmlElement los XmlNode objetos o pueden tener cualquier nombre de elemento.If no Name value is specified, the XmlElement or XmlNode objects can have any element name.

Cuando se llama al Deserialize método de la XmlSerializer clase, todos los elementos que no tienen un miembro correspondiente en el objeto que se está deserializando se recopilan en la 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. Después de la deserialización, recorra en XmlElement iteración la colección de elementos para procesar los datos.After deserialization, iterate through the collection of XmlElement items to process the data. Si especifica un Name valor, la matriz solo contiene los elementos XML con ese nombre.If you specify a Name value, the array contains only XML elements with that name. Si no especifica un Name valor, la matriz contiene todos los elementos que no tienen ningún miembro correspondiente en la clase.If you do not specify a Name value, the array contains all elements that have no corresponding member in the class. Si una clase contiene más de un campo al que se aplica el atributo, utilice las Namepropiedades, Name o Namespace y para diferenciar entre el contenido de las matrices.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. Si este tipo de clase (con varios campos) también contiene un campo que no tiene establecido ningún valor de propiedad diferenciado (en Name otras Namespacepalabras, y) durante la deserialización, esta matriz contiene cualquier elemento XML desconocido que no esté ya incluido en las demás matrices.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. Si una clase contiene más de un campo que no tiene un valor diferenciado Name, o Name y Namespace establecido, el comportamiento durante la deserialización no se especifica.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.

También puede aplicar XmlAnyElementAttribute a un campo que devuelve un solo XmlElement objeto.You can also apply the XmlAnyElementAttribute to a field that returns a single XmlElement object. Si lo hace, debe utilizar las propiedades y los métodos de la XmlElement clase para recorrer en iteración de forma recursiva los elementos desconocidos.If you do so, you must use the properties and methods of the XmlElement class to recursively iterate through the unknown elements.

Puede aplicar varias instancias de XmlAnyElementAttribute a un miembro de clase, pero cada instancia debe tener un valor de propiedad DISTINCT. NameYou can apply multiple instances of the XmlAnyElementAttribute to a class member, but each instance must have a distinct Name property value. O bien, si se Name establece la misma propiedad para cada instancia, debe Namespace establecerse un valor de propiedad distinto para cada instancia.Or, if the same Name property is set for each instance, a distinct Namespace property value must be set for each instance.

Los UnknownNode eventos UnknownAttribute y XmlAnyElementAttribute del XmlSerializer no se producen si se aplica a un miembro de una clase.The UnknownNode and UnknownAttribute events of the XmlSerializer do not occur if you apply the XmlAnyElementAttribute to a member of a class.

Nota

Puede usar la palabra XmlAnyElement en el código en lugar de la más larga. XmlAnyElementAttributeYou can use the word XmlAnyElement in your code instead of the longer XmlAnyElementAttribute.

Para obtener más información sobre el uso de atributos, vea atributos.For more information about using attributes, see Attributes.

Constructores

XmlAnyElementAttribute() XmlAnyElementAttribute() XmlAnyElementAttribute() XmlAnyElementAttribute()

Inicializa una nueva instancia de la clase XmlAnyElementAttribute.Initializes a new instance of the XmlAnyElementAttribute class.

XmlAnyElementAttribute(String) XmlAnyElementAttribute(String) XmlAnyElementAttribute(String) XmlAnyElementAttribute(String)

Inicializa una nueva instancia de la clase XmlAnyElementAttribute y especifica el nombre del elemento XML generado en el documento XML.Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document.

XmlAnyElementAttribute(String, String) XmlAnyElementAttribute(String, String) XmlAnyElementAttribute(String, String) XmlAnyElementAttribute(String, String)

Inicializa una nueva instancia de la clase XmlAnyElementAttribute y especifica el nombre del elemento XML generado en el documento XML y su espacio de nombres XML.Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document and its XML namespace.

Propiedades

Name Name Name Name

Obtiene o establece el nombre del elemento XML.Gets or sets the XML element name.

Namespace Namespace Namespace Namespace

Obtiene o establece el espacio de nombres XML generado en el documento XML.Gets or sets the XML namespace generated in the XML document.

Order Order Order Order

Obtiene o establece el orden explícito en el que los elementos son serializados o deserializados.Gets or sets the explicit order in which the elements are serialized or deserialized.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consulte también: