XmlArrayItemAttribute Класс

Определение

Пространство имен:

System.Xml.Serialization

Сборка:

System.Xml.XmlSerializer.dll

Исходный код:

XmlArrayItemAttribute.cs

Представляет атрибут, который определяет производные типы, которые могут быть размещены XmlSerializer в сериализованном массиве.

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

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

Public Class XmlArrayItemAttribute
Inherits Attribute

Наследование

Object

Attribute

XmlArrayItemAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере выполняется сериализация класса с именем Group , содержащего поле с именем Employees , возвращающее массив Employee объектов . В примере применяется XmlArrayItemAttribute к полю , тем самым указывая XmlSerializer , что он может вставлять объекты как базового класса (Employee), так и производного типа класса (Manager) в сериализованный массив.

#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

Комментарии

принадлежит XmlArrayItemAttribute к семейству атрибутов, которые управляют тем, как XmlSerializer сериализует или десериализует объект. Полный список аналогичных атрибутов см. в разделе Атрибуты, управляющие сериализацией XML.

Можно применить к любому общедоступному элементу XmlArrayItemAttribute для чтения и записи, который возвращает массив или предоставляет доступ к нему. Например, поле, возвращающее массив объектов , коллекцию, или любой ArrayListкласс, реализующий IEnumerable интерфейс .

поддерживает XmlArrayItemAttribute полиморфизм, то есть позволяет добавлять производные XmlSerializer объекты в массив. Например, предположим, что класс с именем Mammal является производным от базового класса с именем Animal. Далее предположим, что класс с именем MyAnimals содержит поле, возвращающее массив Animal объектов . Чтобы разрешить XmlSerializer сериализовать тип Animal и Mammal , примените XmlArrayItemAttribute к полю дважды, каждый раз указывая один из двух допустимых типов.

Примечание

Можно применить несколько экземпляров XmlArrayItemAttribute или XmlElementAttribute , чтобы указать типы объектов, которые можно вставить в массив.

Примечание

Сериализация поля или свойства, возвращающего интерфейс или массив интерфейсов, не поддерживается.

Дополнительные сведения об использовании атрибутов см. в разделе Атрибуты.

Примечание

Вы можете использовать слово XmlArrayItem в коде вместо более длинного XmlArrayItemAttribute.

Конструкторы

XmlArrayItemAttribute()	Инициализирует новый экземпляр класса XmlArrayItemAttribute.
XmlArrayItemAttribute(String)	Инициализация нового экземпляра класса XmlArrayItemAttribute и указывает имя элемента XML, сгенерированного в документе XML.
XmlArrayItemAttribute(String, Type)	Инициализация нового экземпляра класса XmlArrayItemAttribute и определяет имя элемента XML, сгенерированного в документе XML, и Type, который может быть вставлен в сгенерированный документ XML.
XmlArrayItemAttribute(Type)	Инициализация нового экземпляра класса XmlArrayItemAttribute и определяет Type, который может быть вставлен в сериализованный массив.

Свойства

DataType	Возвращает или задает тип данных XML сгенерированного элемента XML.
ElementName	Получает или задает имя созданного XML-элемента
Form	Возвращает или задает значение, которое указывает, является ли имя сгенерированного элемента XML полным.
IsNullable	Получает или задает значение, которое показывает, должен ли XmlSerializer выполнить сериализацию члена как пустого тега XML с атрибутом xsi:nil, для которого установлено значение true.
Namespace	Возвращает или задает пространство имен сгенерированного элемента XML.
NestingLevel	Возвращает или задает уровень в иерархии элементов XML, на который воздействует XmlArrayItemAttribute.
Type	Возвращает или задает тип, допустимый в массиве.
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)

Методы

Equals(Object)	Возвращает значение, показывающее, равен ли экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• XmlArrayAttribute
• XmlSerializer
• XmlArrayItems
• XmlAttributeOverrides
• XmlAttributes
• Введение в сериализацию XML
• Практическое руководство. Указание имени альтернативного элемента для потока XML
• Управление сериализацией XML с использованием атрибутов
• Примеры сериализации XML
• Инструмент определения схемы XML (Xsd.exe)