XmlAttributeOverrides Класс

Определение

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

System.Xml.Serialization

Сборки:

netstandard.dll, System.Xml.XmlSerializer.dll

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

XmlAttributeOverrides.cs

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

public ref class XmlAttributeOverrides

public class XmlAttributeOverrides

type XmlAttributeOverrides = class

Public Class XmlAttributeOverrides

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

Object

XmlAttributeOverrides

Примеры

В следующем примере сериализуется класс с именем Orchestra, который содержит одно поле с именем Instruments , которое возвращает массив Instrument объектов. Второй класс с именем Brass наследует от Instrument класса. В примере используется экземпляр XmlAttributeOverrides класса для переопределения Instrument поля, что позволяет полю принимать Brass объекты.

using System;
using System.IO;
using System.Xml.Serialization;

public class Orchestra
{
   public Instrument[] Instruments;
}

public class Instrument
{
   public string Name;
}

public class Brass:Instrument
{
   public bool IsValved;
}

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

    public void SerializeObject(string filename)
    {
      /* Each overridden field, property, or type requires
      an XmlAttributes object. */
      XmlAttributes attrs = new XmlAttributes();

      /* Create an XmlElementAttribute to override the
      field that returns Instrument objects. The overridden field
      returns Brass objects instead. */
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

      // Add the element to the collection of elements.
      attrs.XmlElements.Add(attr);

      // Create the XmlAttributeOverrides object.
      XmlAttributeOverrides attrOverrides = new XmlAttributeOverrides();

      /* Add the type of the class that contains the overridden
      member and the XmlAttributes to override it with to the
      XmlAttributeOverrides object. */
      attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s =
      new XmlSerializer(typeof(Orchestra), attrOverrides);

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create the object that will be serialized.
      Orchestra band = new Orchestra();

      // Create an object of the derived type.
      Brass i = new Brass();
      i.Name = "Trumpet";
      i.IsValved = true;
      Instrument[] myInstruments = {i};
      band.Instruments = myInstruments;

      // Serialize the object.
      s.Serialize(writer,band);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();
      XmlAttributes attrs = new XmlAttributes();

      // Create an XmlElementAttribute to override the Instrument.
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

      // Add the XmlElementAttribute to the collection of objects.
      attrs.XmlElements.Add(attr);

      attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s =
      new XmlSerializer(typeof(Orchestra), attrOverrides);

      FileStream fs = new FileStream(filename, FileMode.Open);
      Orchestra band = (Orchestra) s.Deserialize(fs);
      Console.WriteLine("Brass:");

      /* The difference between deserializing the overridden
      XML document and serializing it is this: To read the derived
      object values, you must declare an object of the derived type
      (Brass), and cast the Instrument instance to it. */
      Brass b;
      foreach(Instrument i in band.Instruments)
      {
         b = (Brass)i;
         Console.WriteLine(
         b.Name + "\n" +
         b.IsValved);
      }
   }
}

Option Explicit
Option Strict

Imports System.IO
Imports System.Xml.Serialization

Public Class Orchestra
    Public Instruments() As Instrument
End Class

Public Class Instrument
    Public Name As String
End Class

Public Class Brass
    Inherits Instrument
    Public IsValved As Boolean
End Class

Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("Override.xml")
        test.DeserializeObject("Override.xml")
    End Sub
        
    Public Sub SerializeObject(ByVal filename As String)
        ' Each overridden field, property, or type requires
        ' an XmlAttributes object. 
        Dim attrs As New XmlAttributes()
        
        ' Create an XmlElementAttribute to override the
        ' field that returns Instrument objects. The overridden field
        ' returns Brass objects instead. 
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)
        
        ' Add the element to the collection of elements.
        attrs.XmlElements.Add(attr)
        
        ' Create the XmlAttributeOverrides object.
        Dim attrOverrides As New XmlAttributeOverrides()
        
        ' Add the type of the class that contains the overridden
        ' member and the XmlAttributes to override it with to the
        ' XmlAttributeOverrides object. 
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
        
        ' Create the XmlSerializer using the XmlAttributeOverrides.
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
        
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create the object that will be serialized.
        Dim band As New Orchestra()
        
        ' Create an object of the derived type.
        Dim i As New Brass()
        i.Name = "Trumpet"
        i.IsValved = True
        Dim myInstruments() As Instrument = {i}
        band.Instruments = myInstruments
        
        ' Serialize the object.
        s.Serialize(writer, band)
        writer.Close()
    End Sub    
    
    Public Sub DeserializeObject(filename As String)
        Dim attrOverrides As New XmlAttributeOverrides()
        Dim attrs As New XmlAttributes()
        
        ' Create an XmlElementAttribute to override the Instrument.
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)
        
        ' Add the XmlElementAttribute to the collection of objects.
        attrs.XmlElements.Add(attr)
        
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
        
        ' Create the XmlSerializer using the XmlAttributeOverrides.
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
        
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim band As Orchestra = CType(s.Deserialize(fs), Orchestra)
        Console.WriteLine("Brass:")
        
        ' The difference between deserializing the overridden
        ' XML document and serializing it is this: To read the derived
        ' object values, you must declare an object of the derived type
        ' (Brass), and cast the Instrument instance to it. 
        Dim b As Brass
        Dim i As Instrument
        For Each i In  band.Instruments
            b = CType(i, Brass)
            Console.WriteLine(b.Name & ControlChars.Cr & b.IsValved)
        Next i
    End Sub
End Class

Комментарии

XmlSerializer Позволяет XmlAttributeOverrides переопределить способ сериализации набора объектов по умолчанию. Переопределение сериализации таким образом использует два способа: сначала можно управлять сериализацией объектов, найденных в библиотеке DLL, даже если у вас нет доступа к источнику; во-вторых, можно создать один набор сериализуемых классов, но сериализовать объекты несколькими способами. Например, вместо сериализации элементов экземпляра класса в виде XML-элементов их можно сериализовать в виде XML-атрибутов, что приведет к более эффективному переносу документа.

После создания XmlAttributeOverrides объекта он передается в качестве аргумента конструктору XmlSerializer . В результате XmlSerializer используются данные, содержащиеся в XmlAttributeOverrides переопределении атрибутов, которые управляют сериализацией объектов. Для этого XmlAttributeOverrides содержит коллекцию типов объектов, переопределенных, а также XmlAttributes объект, связанный с каждым переопределенным типом объекта. Сам XmlAttributes объект содержит соответствующий набор объектов атрибутов, которые управляют сериализацией каждого поля, свойства или класса.

Процесс создания и использования XmlAttributeOverrides объекта выглядит следующим образом:

1. Создайте объект XmlAttributes.

2. Создайте объект атрибута, соответствующий переопределению объекта. Например, чтобы переопределить поле или свойство, создайте XmlElementAttributeновый производный тип. При необходимости можно назначить новое ElementNameNamespace или переопределить имя атрибута базового класса или пространство имен.

3. Добавьте объект атрибута в соответствующее XmlAttributes свойство или коллекцию. Например, вы добавите XmlElementAttribute коллекцию XmlElementsXmlAttributes объекта, указав имя члена, которое переопределяется.

4. Создайте объект XmlAttributeOverrides.

5. Add С помощью метода добавьте XmlAttributes объект в XmlAttributeOverrides объект. Если объект переопределен XmlRootAttribute или XmlTypeAttribute, необходимо указать только тип переопределенного объекта. Но если вы переопределяете поле или свойство, необходимо также указать имя переопределенного элемента.

6. При создании XmlSerializerконструктора XmlAttributeOverrides передайте конструктору XmlSerializer .

7. Используйте результат XmlSerializer для сериализации или десериализации производных объектов класса.

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

Имя	Описание
XmlAttributeOverrides()	Инициализирует новый экземпляр класса XmlAttributeOverrides.

Свойства

Имя	Описание
Item[Type, String]	Возвращает объект, связанный с указанным типом (базовым классом). Параметр-член задает элемент базового класса, переопределенный.
Item[Type]	Возвращает объект, связанный с указанным базовым классом, типом.

Методы

Имя	Описание
Add(Type, String, XmlAttributes)	Добавляет объект в XmlAttributes коллекцию XmlAttributes объектов. Параметр type задает объект для переопределения. Параметр member задает имя элемента, переопределенного.
Add(Type, XmlAttributes)	Добавляет объект в XmlAttributes коллекцию XmlAttributes объектов. Параметр type указывает объект, переопределенный XmlAttributes объектом.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

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

• Deserialize(Stream)
• Serialize(TextWriter, Object)
• XmlSerializer
• XmlAttributes
• Введение в сериализацию XML
• Практическое руководство. Указание альтернативного имени элемента для XML-потока
• Управление сериализацией XML с помощью атрибутов
• Примеры сериализации XML
• Инструмент определения схемы XML (Xsd.exe)