XmlAnyElementAttribute Classe

Définition

Spécifie que le membre (un champ retournant un tableau d'objets XmlElement ou XmlNode) contient des objets représentant tout élément XML n'ayant pas de membre correspondant dans l'objet en cours de sérialisation ou de désérialisation.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
Héritage
XmlAnyElementAttribute
Attributs

Exemples

L’exemple suivant applique l' XmlAnyElementAttribute à un champ nommé AllElements qui retourne un tableau d’objets XmlElement.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

Remarques

Conseil

Lorsque vous travaillez dans une bibliothèque de classes portable, par exemple dans Silverlight, Windows Phone ou un projet d’application du Windows Store, et que vous utilisez le .NET Framework 4.0.3 et versions ultérieures, utilisez XElement ou XNode à la place de XmlElement et XmlNode.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.

Utilisez la XmlAnyElementAttribute pour contenir des données arbitraires (en tant qu’éléments XML) qui peuvent être envoyées dans le cadre d’un document XML, telles que les métadonnées envoyées dans le cadre du document.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.

Appliquez la XmlAnyElementAttribute à un champ qui retourne un tableau d’objets XmlElement ou XmlNode.Apply the XmlAnyElementAttribute to a field that returns an array of XmlElement or XmlNode objects. Ce champ peut être utilisé de deux façons, selon qu’un objet est en cours de sérialisation ou de désérialisation.Such a field can be used in two ways, depending on whether an object is being serialized or deserialized. Lorsqu’il est sérialisé, l’objet est généré sous forme de nœuds ou d’éléments XML, même s’ils n’ont aucun membre (ou membre) correspondant dans l’objet en cours de sérialisation.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 vous spécifiez une valeur de propriété Name lors de l’application de l’attribut, tous les objets XmlElement ou XmlNode insérés dans le tableau doivent avoir le même nom d’élément et l’espace de noms par défaut, ou une exception est levée.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 vous définissez la valeur de la propriété Namespace, vous devez également définir la propriété Name, et les objets XmlElement ou XmlNode doivent également avoir les mêmes valeurs de nom et d’espace de noms.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 aucune valeur de Name n’est spécifiée, les objets XmlElement ou XmlNode peuvent avoir n’importe quel nom d’élément.If no Name value is specified, the XmlElement or XmlNode objects can have any element name.

Quand vous appelez la méthode Deserialize de la classe XmlSerializer, tous les éléments qui n’ont pas de membre correspondant dans l’objet en cours de désérialisation sont collectés dans le tableau.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. Après la désérialisation, itérez au sein de la collection d’éléments de XmlElement pour traiter les données.After deserialization, iterate through the collection of XmlElement items to process the data. Si vous spécifiez une valeur Name, le tableau contient uniquement des éléments XML portant ce nom.If you specify a Name value, the array contains only XML elements with that name. Si vous ne spécifiez pas de valeur Name, le tableau contient tous les éléments qui n’ont pas de membre correspondant dans la classe.If you do not specify a Name value, the array contains all elements that have no corresponding member in the class. Si une classe contient plusieurs champs auxquels l’attribut est appliqué, utilisez les propriétés Nameou Name et Namespace pour différencier le contenu des tableaux.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 une telle classe (avec plusieurs champs) contient également un champ pour lequel aucune valeur de propriété de différenciation n’est définie (en d’autres termes, Name et Namespace) pendant la désérialisation, ce tableau contient tous les éléments XML inconnus qui ne sont pas déjà contenus dans les autres tableaux.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 une classe contient plus d’un champ qui n’a pas de Namede différenciation, ou Name et Namespace valeur définie, le comportement pendant la désérialisation n’est pas spécifié.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.

Vous pouvez également appliquer la XmlAnyElementAttribute à un champ qui retourne un objet XmlElement unique.You can also apply the XmlAnyElementAttribute to a field that returns a single XmlElement object. Dans ce cas, vous devez utiliser les propriétés et les méthodes de la classe XmlElement pour itérer de manière récursive les éléments inconnus.If you do so, you must use the properties and methods of the XmlElement class to recursively iterate through the unknown elements.

Vous pouvez appliquer plusieurs instances de l' XmlAnyElementAttribute à un membre de classe, mais chaque instance doit avoir une valeur de propriété Name distincte.You can apply multiple instances of the XmlAnyElementAttribute to a class member, but each instance must have a distinct Name property value. Ou, si la même propriété de Name est définie pour chaque instance, une valeur de propriété Namespace distincte doit être définie pour chaque instance.Or, if the same Name property is set for each instance, a distinct Namespace property value must be set for each instance.

Les événements UnknownNode et UnknownAttribute de l' XmlSerializer ne se produisent pas si vous appliquez l' XmlAnyElementAttribute à un membre d’une classe.The UnknownNode and UnknownAttribute events of the XmlSerializer do not occur if you apply the XmlAnyElementAttribute to a member of a class.

Notes

Vous pouvez utiliser le mot XmlAnyElement dans votre code au lieu du XmlAnyElementAttributeplus long.You can use the word XmlAnyElement in your code instead of the longer XmlAnyElementAttribute.

Pour plus d’informations sur l’utilisation d’attributs, consultez attributs.For more information about using attributes, see Attributes.

Constructeurs

XmlAnyElementAttribute()

Initialise une nouvelle instance de la classe XmlAnyElementAttribute.Initializes a new instance of the XmlAnyElementAttribute class.

XmlAnyElementAttribute(String)

Initialise une nouvelle instance de la classe XmlAnyElementAttribute et spécifie le nom d'élément XML généré dans le document XML.Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document.

XmlAnyElementAttribute(String, String)

Initialise une nouvelle instance de la classe XmlAnyElementAttribute et spécifie le nom d'élément XML généré dans le document XML, ainsi que son espace de noms XML.Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document and its XML namespace.

Propriétés

Name

Obtient ou définit le nom de l'élément XML.Gets or sets the XML element name.

Namespace

Obtient ou définit l'espace de noms XML généré dans le document XML.Gets or sets the XML namespace generated in the XML document.

Order

Obtient ou définit l'ordre explicite dans lequel les éléments sont sérialisés ou désérialisés.Gets or sets the explicit order in which the elements are serialized or deserialized.

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Hérité de Attribute)

Méthodes

Equals(Object)

Retourne une valeur qui indique si cette instance est égale à un objet spécifié.Returns a value that indicates whether this instance is equal to a specified object.

(Hérité de Attribute)
GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

(Hérité de Attribute)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Hérité de Attribute)
Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Hérité de Object)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.Provides access to properties and methods exposed by an object.

(Hérité de Attribute)

S’applique à

Voir aussi