XmlArrayItemAttribute Klasse

Definition

Stellt ein Attribut dar, das die abgeleiteten Typen angibt, welche der XmlSerializer in ein serialisiertes Array einfügen kann.Represents an attribute that specifies the derived types that the XmlSerializer can place in a serialized array.

public ref class XmlArrayItemAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=true)]
public class XmlArrayItemAttribute : Attribute
type XmlArrayItemAttribute = class
    inherit Attribute
Public Class XmlArrayItemAttribute
Inherits Attribute
Vererbung
XmlArrayItemAttribute
Attribute

Beispiele

Im folgenden Beispiel wird eine Klasse mit dem Namen Group serialisiert, die ein Feld mit dem Namen Employees enthält, das ein Array von Employee Objekten zurückgibt.The following example serializes a class named Group that contains a field named Employees that returns an array of Employee objects. Im Beispiel wird das-XmlArrayItemAttribute auf das-Feld angewendet. Dadurch wird die XmlSerializer angewiesen, dass Sie Objekte vom Typ der Basisklasse (Employee) und vom abgeleiteten Klassentyp (Manager) in das serialisierte Array einfügen können.The example applies the XmlArrayItemAttribute to the field, thereby instructing the XmlSerializer that it can insert objects of both the base class (Employee) type and derived class type (Manager) into the serialized array.

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;

public ref class Employee
{
public:
   String^ Name;
};

public ref class Manager: public Employee
{
public:
   int Level;
};

public ref class Group
{
public:

   /* The XmlArrayItemAttribute allows the XmlSerializer to insert
      both the base type (Employee) and derived type (Manager) 
      into serialized arrays. */

   [XmlArrayItem(Manager::typeid),
   XmlArrayItem(Employee::typeid)]
   array<Employee^>^Employees;

   /* Use the XmlArrayItemAttribute to specify types allowed
      in an array of Object items. */

   [XmlArray]
   [XmlArrayItem(Int32::typeid,
   ElementName="MyNumber"),
   XmlArrayItem(String::typeid,
   ElementName="MyString"),
   XmlArrayItem(Manager::typeid)]
   array<Object^>^ExtraInfo;
};

void SerializeObject( String^ filename )
{
   // Creates a new XmlSerializer.
   XmlSerializer^ s = gcnew XmlSerializer( Group::typeid );

   // Writing the XML file to disk requires a TextWriter.
   TextWriter^ writer = gcnew StreamWriter( filename );
   Group^ group = gcnew Group;
   Manager^ manager = gcnew Manager;
   Employee^ emp1 = gcnew Employee;
   Employee^ emp2 = gcnew Employee;
   manager->Name = "Consuela";
   manager->Level = 3;
   emp1->Name = "Seiko";
   emp2->Name = "Martina";
   array<Employee^>^emps = {manager,emp1,emp2};
   group->Employees = emps;

   // Creates an int and a string and assigns to ExtraInfo.
   array<Object^>^temp = {43,"Extra",manager};
   group->ExtraInfo = temp;

   // Serializes the object, and closes the StreamWriter.
   s->Serialize( writer, group );
   writer->Close();
}

void DeserializeObject( String^ filename )
{
   FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
   XmlSerializer^ x = gcnew XmlSerializer( Group::typeid );
   Group^ g = dynamic_cast<Group^>(x->Deserialize( fs ));
   Console::WriteLine( "Members:" );
   System::Collections::IEnumerator^ myEnum = g->Employees->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Employee^ e = safe_cast<Employee^>(myEnum->Current);
      Console::WriteLine( "\t{0}", e->Name );
   }
}

int main()
{
   SerializeObject( "TypeDoc.xml" );
   DeserializeObject( "TypeDoc.xml" );
}
using System;
using System.IO;
using System.Xml.Serialization;

public class Group
{
   /* The XmlArrayItemAttribute allows the XmlSerializer to insert
      both the base type (Employee) and derived type (Manager)
      into serialized arrays. */

   [XmlArrayItem(typeof(Manager)),
   XmlArrayItem(typeof(Employee))]
   public Employee[] Employees;

   /* Use the XmlArrayItemAttribute to specify types allowed
      in an array of Object items. */
   [XmlArray]
   [XmlArrayItem (typeof(int),
   ElementName = "MyNumber"),
   XmlArrayItem (typeof(string),
   ElementName = "MyString"),
   XmlArrayItem(typeof(Manager))]
   public object [] ExtraInfo;
}

public class Employee
{
   public string Name;
}

public class Manager:Employee{
   public int Level;
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("TypeDoc.xml");
      test.DeserializeObject("TypeDoc.xml");
   }

   public void SerializeObject(string filename)
   {
      // Creates a new XmlSerializer.
      XmlSerializer s = new XmlSerializer(typeof(Group));

      // Writing the XML file to disk requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);
      Group group = new Group();

      Manager manager = new Manager();
      Employee emp1 = new Employee();
      Employee emp2 = new Employee();
      manager.Name = "Consuela";
      manager.Level = 3;
      emp1.Name = "Seiko";
      emp2.Name = "Martina";
      Employee [] emps = new Employee[3]{manager, emp1, emp2};
      group.Employees = emps;

      // Creates an int and a string and assigns to ExtraInfo.
      group.ExtraInfo = new Object[3]{43, "Extra", manager};

      // Serializes the object, and closes the StreamWriter.
      s.Serialize(writer, group);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      FileStream fs = new FileStream(filename, FileMode.Open);
      XmlSerializer x = new XmlSerializer(typeof(Group));
      Group g = (Group) x.Deserialize(fs);
      Console.WriteLine("Members:");

      foreach(Employee e in g.Employees)
      {
         Console.WriteLine("\t" + e.Name);
      }
   }
}

Option Explicit
Option Strict

Imports System.IO
Imports System.Xml.Serialization

Public Class Group
    ' The XmlArrayItemAttribute allows the XmlSerializer to insert
    ' both the base type (Employee) and derived type (Manager)
    ' into serialized arrays. 
    
    <XmlArrayItem(GetType(Manager)), _
     XmlArrayItem(GetType(Employee))> _
    Public Employees() As Employee
    
    ' Use the XmlArrayItemAttribute to specify types allowed
    ' in an array of Object items. 
    <XmlArray(), _
     XmlArrayItem(GetType(Integer), ElementName := "MyNumber"), _
     XmlArrayItem(GetType(String), ElementName := "MyString"), _
     XmlArrayItem(GetType(Manager))> _
    Public ExtraInfo() As Object
End Class

Public Class Employee
    Public Name As String
End Class

Public Class Manager
    Inherits Employee
    Public Level As Integer
End Class


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("TypeDoc.xml")
        test.DeserializeObject("TypeDoc.xml")
    End Sub
    
       
    Public Sub SerializeObject(ByVal filename As String)
        ' Creates a new XmlSerializer.
        Dim s As New XmlSerializer(GetType(Group))
        
        ' Writing the XML file to disk requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        Dim group As New Group()
        
        Dim manager As New Manager()
        Dim emp1 As New Employee()
        Dim emp2 As New Employee()
        manager.Name = "Consuela"
        manager.Level = 3
        emp1.Name = "Seiko"
        emp2.Name = "Martina"
        Dim emps() As Employee = {manager, emp1, emp2}
        group.Employees = emps
        
        ' Creates an int and a string and assigns to ExtraInfo.
        group.ExtraInfo = New Object() {43, "Extra", manager}
        
        ' Serializes the object, and closes the StreamWriter.
        s.Serialize(writer, group)
        writer.Close()
    End Sub
    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim x As New XmlSerializer(GetType(Group))
        Dim g As Group = CType(x.Deserialize(fs), Group)
        Console.WriteLine("Members:")
        
        Dim e As Employee
        For Each e In  g.Employees
            Console.WriteLine(ControlChars.Tab & e.Name)
        Next e
    End Sub
End Class

Hinweise

Der XmlArrayItemAttribute gehört zu einer Reihe von Attributen, die Steuern, wie das XmlSerializer ein Objekt serialisiert oder deserialisiert.The XmlArrayItemAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Eine umfassende Liste mit ähnlichen Attributen finden Sie unter Attribute, die die XML-Serialisierung steuern.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Sie können den XmlArrayItemAttribute auf jeden öffentlichen Lese-/Schreibmember anwenden, der ein Array zurückgibt, oder auf einen zugreifen.You can apply the XmlArrayItemAttribute to any public read/write member that returns an array, or provides access to one. Beispielsweise ein Feld, das ein Array von-Objekten, eine Auflistung, eine ArrayListoder eine beliebige Klasse zurückgibt, die die IEnumerable-Schnittstelle implementiert.For example, a field that returns an array of objects, a collection, an ArrayList, or any class that implements the IEnumerable interface.

Der XmlArrayItemAttribute unterstützt Polymorphie, d. h. er ermöglicht es dem XmlSerializer, einem Array abgeleitete Objekte hinzuzufügen.The XmlArrayItemAttribute supports polymorphism--in other words, it allows the XmlSerializer to add derived objects to an array. Angenommen, eine Klasse mit dem Namen Mammal wird von einer Basisklasse mit dem Namen Animalabgeleitet.For example, suppose a class named Mammal is derived from a base class named Animal. Angenommen, eine Klasse mit dem Namen MyAnimals enthält ein Feld, das ein Array von Animal Objekten zurückgibt.Further suppose that a class named MyAnimals contains a field that returns an array of Animal objects. Damit der XmlSerializer sowohl den Animal als auch Mammal Typ serialisieren kann, wenden Sie das XmlArrayItemAttribute zweimal auf das Feld an, und geben Sie dabei jedes Mal einen der beiden zulässigen Typen an.To allow the XmlSerializer to serialize both the Animal and Mammal type, apply the XmlArrayItemAttribute to the field twice, each time specifying one of the two acceptable types.

Hinweis

Sie können mehrere Instanzen der XmlArrayItemAttribute oder XmlElementAttribute anwenden, um Typen von Objekten anzugeben, die in das Array eingefügt werden können.You can apply multiple instances of the XmlArrayItemAttribute or XmlElementAttribute to specify types of objects that can be inserted into the array.

Hinweis

Die Serialisierung eines Felds oder einer Eigenschaft, die eine Schnittstelle oder ein Array von Schnittstellen zurückgibt, wird nicht unterstützt.The serialization of a field or property that returns an interface or array of interfaces is not supported.

Weitere Informationen zum Verwenden von Attributen finden Sie unter Attribute.For more information about using attributes, see Attributes.

Hinweis

Sie können das Wort XmlArrayItem in Ihrem Code verwenden, anstatt das längere XmlArrayItemAttribute.You can use the word XmlArrayItem in your code instead of the longer XmlArrayItemAttribute.

Konstruktoren

XmlArrayItemAttribute()

Initialisiert eine neue Instanz der XmlArrayItemAttribute-Klasse.Initializes a new instance of the XmlArrayItemAttribute class.

XmlArrayItemAttribute(String)

Initialisiert eine neue Instanz der XmlArrayItemAttribute-Klasse und gibt den Namen des im XML-Dokument generierten XML-Elements an.Initializes a new instance of the XmlArrayItemAttribute class and specifies the name of the XML element generated in the XML document.

XmlArrayItemAttribute(String, Type)

Initialisiert eine neue Instanz der XmlArrayItemAttribute-Klasse und gibt den Namen des im XML-Dokument generierten XML-Elements sowie den Type an, der in das generierte XML-Dokument eingefügt werden kann.Initializes a new instance of the XmlArrayItemAttribute class and specifies the name of the XML element generated in the XML document and the Type that can be inserted into the generated XML document.

XmlArrayItemAttribute(Type)

Initialisiert eine Instanz der XmlArrayItemAttribute-Klasse und gibt den Type an, der in das serialisierte Array eingefügt werden kann.Initializes a new instance of the XmlArrayItemAttribute class and specifies the Type that can be inserted into the serialized array.

Eigenschaften

DataType

Ruft den XML-Datentyp des generierten XML-Elements ab oder legt diesen fest.Gets or sets the XML data type of the generated XML element.

ElementName

Ruft den Namen des generierten XML-Elements ab oder legt diesen fest.Gets or sets the name of the generated XML element.

Form

Ruft einen Wert ab, der angibt, ob der Name des generierten XML-Elements gekennzeichnet ist, oder legt diesen fest.Gets or sets a value that indicates whether the name of the generated XML element is qualified.

IsNullable

Ruft einen Wert ab, der angibt, ob XmlSerializer einen Member als leeres XML-Tag, bei dem das xsi:nil-Attribut auf true festgelegt ist, serialisieren muss, oder legt diesen fest.Gets or sets a value that indicates whether the XmlSerializer must serialize a member as an empty XML tag with the xsi:nil attribute set to true.

Namespace

Ruft den Namespace des generierten XML-Elements ab oder legt diesen fest.Gets or sets the namespace of the generated XML element.

NestingLevel

Ruft die Ebene in einer Hierarchie von XML-Elementen ab, auf die das XmlArrayItemAttribute angewendet wird, oder legt diese fest.Gets or sets the level in a hierarchy of XML elements that the XmlArrayItemAttribute affects.

Type

Ruft den in einem Array zulässigen Typ ab oder legt diesen fest.Gets or sets the type allowed in an array.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch