XmlAttributes Класс

Определение

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

System.Xml.Serialization

Сборки:

netstandard.dll, System.Xml.XmlSerializer.dll

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

XmlAttributes.cs

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

public ref class XmlAttributes

public class XmlAttributes

type XmlAttributes = class

Public Class XmlAttributes

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

Object

XmlAttributes

Примеры

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

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 element to the collection of elements.
      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);
      }
   }
}

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(ByVal 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 element to the collection of elements.
        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.ToString())
        Next i
    End Sub
End Class

Комментарии

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

Члены XmlAttributes класса соответствуют непосредственно семейству классов атрибутов, которые управляют сериализацией. Например, XmlText свойство должно иметь XmlTextAttributeзначение , которое позволяет переопределить сериализацию поля или свойства, указав XmlSerializer сериализацию значения свойства в виде XML-текста. Полный список атрибутов, управляющих сериализацией, см. в разделе XmlSerializer.

Дополнительные сведения об использовании XmlAttributeOverrides класса XmlAttributes см. в разделе "Практическое руководство. Указание альтернативного имени элемента для XML-потока".

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

Имя	Описание
XmlAttributes()	Инициализирует новый экземпляр класса XmlAttributes.
XmlAttributes(ICustomAttributeProvider)	Инициализирует новый экземпляр XmlAttributes класса и настраивает XmlSerializer способ сериализации и десериализации объекта.

Свойства

Имя	Описание
XmlAnyAttribute	Возвращает или задает XmlAnyAttributeAttribute переопределение.
XmlAnyElements	Возвращает коллекцию объектов для XmlAnyElementAttribute переопределения.
XmlArray	Возвращает или задает объект, указывающий, как XmlSerializer сериализует общедоступное поле или свойство чтения или записи, возвращающее массив.
XmlArrayItems	Возвращает или задает коллекцию объектов, которые указывают, как XmlSerializer сериализует элементы, вставляемые в массив, возвращаемый общедоступным полем или свойством чтения или записи.
XmlAttribute	Возвращает или задает объект, указывающий, как XmlSerializer сериализует общедоступное поле или общедоступное свойство чтения и записи в виде XML-атрибута.
XmlChoiceIdentifier	Возвращает или задает объект, позволяющий различать набор вариантов.
XmlDefaultValue	Возвращает или задает значение по умолчанию xml-элемента или атрибута.
XmlElements	Возвращает коллекцию объектов, указывающих, как XmlSerializer сериализует общедоступное поле или свойство чтения или записи в виде XML-элемента.
XmlEnum	Возвращает или задает объект, указывающий XmlSerializer способ сериализации элемента перечисления.
XmlIgnore	Возвращает или задает значение, указывающее, сериализует ли XmlSerializer сериализация общедоступного поля или общедоступного свойства чтения и записи.
Xmlns	Возвращает или задает значение, указывающее, следует ли хранить все объявления пространства имен при переопределении объекта, содержащего элемент, возвращающий XmlSerializerNamespaces объект.
XmlRoot	Возвращает или задает объект, указывающий, как XmlSerializer сериализует класс в качестве корневого элемента XML.
XmlText	Возвращает или задает объект, который указывает XmlSerializer сериализации общедоступного поля или общедоступного свойства чтения или записи в виде XML-текста.
XmlType	Возвращает или задает объект, указывающий, как XmlSerializer сериализует класс, к которому XmlTypeAttribute применено приложение.

Методы

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

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

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