XmlObjectSerializer Класс

Ссылка

Определение

Пространство имен:: System.Runtime.Serialization

Сборка:: System.Runtime.Serialization.Xml.dll

Сборка:: System.Runtime.Serialization.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предоставляет базовый класс для сериализации объектов в XML-потоки или XML-документы. Это абстрактный класс.

public ref class XmlObjectSerializer abstract

public abstract class XmlObjectSerializer

type XmlObjectSerializer = class

Public MustInherit Class XmlObjectSerializer

Наследование: Object
XmlObjectSerializer

Производный: System.Runtime.Serialization.DataContractSerializer

System.Runtime.Serialization.Json.DataContractJsonSerializer

System.Runtime.Serialization.NetDataContractSerializer

Примеры

В следующем примере показан метод WriteObjectWithInstance, включающий XmlObjectSerializer в качестве параметра. Этот метод сериализует объект с помощью DataContractSerializer или NetDataContractSerializer, вызывая метод WriteObject.

public class Test
{
    private void WriteObjectWithInstance(XmlObjectSerializer xm, Company graph,
       string fileName)
    {
        // Use either the XmlDataContractSerializer or NetDataContractSerializer,
        // or any other class that inherits from XmlObjectSerializer to write with.
        Console.WriteLine(xm.GetType());
        FileStream fs = new FileStream(fileName, FileMode.Create);
        XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
        xm.WriteObject(writer, graph);
        Console.WriteLine("Done writing {0}", fileName);
    }

    private void Run()
    {
        // Create the object to write to a file.
        Company graph = new Company();
        graph.Name = "cohowinery.com";

        // Create a DataContractSerializer and a NetDataContractSerializer.
        // Pass either one to the WriteObjectWithInstance method.
        DataContractSerializer dcs = new DataContractSerializer(typeof(Company));
        NetDataContractSerializer ndcs = new NetDataContractSerializer();
        WriteObjectWithInstance(dcs, graph, @"datacontract.xml");
        WriteObjectWithInstance(ndcs, graph, @"netDatacontract.xml");
    }

    [DataContract]
    public class Company
    {
        [DataMember]
        public string Name;
    }

    static void Main()
    {
        try
        {
            Console.WriteLine("Starting");
            Test t = new Test();
            t.Run();
            Console.WriteLine("Done");
            Console.ReadLine();
        }

        catch (InvalidDataContractException iExc)
        {
            Console.WriteLine("You have an invalid data contract: ");
            Console.WriteLine(iExc.Message);
            Console.ReadLine();
        }

        catch (SerializationException serExc)
        {
            Console.WriteLine("There is a problem with the instance:");
            Console.WriteLine(serExc.Message);
            Console.ReadLine();
        }

        catch (QuotaExceededException qExc)
        {
            Console.WriteLine("The quota has been exceeded");
            Console.WriteLine(qExc.Message);
            Console.ReadLine();
        }
        catch (Exception exc)
        {
            Console.WriteLine(exc.Message);
            Console.WriteLine(exc.ToString());
            Console.ReadLine();
        }
    }

Public Class Test
    
    Private Sub WriteObjectWithInstance(ByVal xm As XmlObjectSerializer, _
      ByVal graph As Company, ByVal fileName As String) 
        ' Use either the XmlDataContractSerializer or NetDataContractSerializer,
        ' or any other class that inherits from XmlObjectSerializer to write with.
        Console.WriteLine(xm.GetType())
        Dim fs As New FileStream(fileName, FileMode.Create)
        Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
        xm.WriteObject(writer, graph)
        Console.WriteLine("Done writing {0}", fileName)
    
    End Sub 
    
    
    Private Sub Run() 
        ' Create the object to write to a file.
        Dim graph As New Company()
        graph.Name = "cohowinery.com"
        
        ' Create a DataContractSerializer and a NetDataContractSerializer.
        ' Pass either one to the WriteObjectWithInstance method.
        Dim dcs As New DataContractSerializer(GetType(Company))
        Dim ndcs As New NetDataContractSerializer()
        WriteObjectWithInstance(dcs, graph, "datacontract.xml")
        WriteObjectWithInstance(ndcs, graph, "netDatacontract.xml")
    
    End Sub 
    
    <DataContract()>  _
    Public Class Company
        <DataMember()>  _
        Public Name As String
    End Class 
    
    
    Shared Sub Main() 
        Try
            Console.WriteLine("Starting")
            Dim t As New Test()
            t.Run()
            Console.WriteLine("Done")
            Console.ReadLine()
        
        Catch iExc As InvalidDataContractException
            Console.WriteLine("You have an invalid data contract: ")
            Console.WriteLine(iExc.Message)
            Console.ReadLine()
        
        Catch serExc As SerializationException
            Console.WriteLine("There is a problem with the instance:")
            Console.WriteLine(serExc.Message)
            Console.ReadLine()
        
        Catch qExc As QuotaExceededException
            Console.WriteLine("The quota has been exceeded")
            Console.WriteLine(qExc.Message)
            Console.ReadLine()
        Catch exc As Exception
            Console.WriteLine(exc.Message)
            Console.WriteLine(exc.ToString())
            Console.ReadLine()
        End Try
    
    End Sub 
End Class

Выполните расширение метода XmlObjectSerializer, чтобы создать сериализатор для сериализации и десериализации объектов. Классы DataContractSerializer и NetDataContractSerializer наследуют от XmlObjectSerializer и используются для сериализации и десериализации объектов, удовлетворяющих правилам контракта данных (объектов, созданных с применением атрибутов DataContractAttribute и DataMemberAttribute).

Примечания для тех, кто реализует этот метод

При наследовании от класса XmlObjectSerializer необходимо переопределить следующие члены: WriteStartObject(XmlDictionaryWriter, Object), WriteObjectContent(XmlDictionaryWriter, Object), WriteEndObject(XmlDictionaryWriter). Кроме того, для чтения и десериализации необходимо применять методы IsStartObject и ReadObject.

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

XmlObjectSerializer()

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

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsStartObject(XmlDictionaryReader)	Возвращает значение, указывающее, расположено ли средство чтения XmlDictionaryReader на элементе XML, который можно считать.
IsStartObject(XmlReader)	Возвращает значение, указывающее, расположено ли средство чтения XmlReader на элементе XML, который можно считать.
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ReadObject(Stream)	Считывает XML-поток или XML-документ с помощью средства чтения Stream и возвращает десериализованный объект.
ReadObject(XmlDictionaryReader)	Считывает XML-документ или XML-поток с помощью средства чтения XmlDictionaryReader и возвращает десериализованный объект.
ReadObject(XmlDictionaryReader, Boolean)	Считывает XML-поток или XML-документ с помощью средства чтения XmlDictionaryReader и возвращает десериализованный объект; также позволяет указать перед попыткой чтения, может ли сериализатор считать данные.
ReadObject(XmlReader)	Считывает XML-документ или XML-поток с помощью средства чтения XmlReader и возвращает десериализованный объект.
ReadObject(XmlReader, Boolean)	Считывает XML-документ или XML-поток с помощью средства чтения XmlReader и возвращает десериализованный объект; также позволяет указать перед попыткой чтения, может ли сериализатор считать данные.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
WriteEndObject(XmlDictionaryWriter)	Записывает завершающий элемент данных объекта в качестве закрывающего XML-элемента в XML-документ или XML-поток с помощью средства записи XmlDictionaryWriter.
WriteEndObject(XmlWriter)	Записывает завершающий элемент данных объекта в качестве закрывающего XML-элемента в XML-документ или XML-поток с помощью средства записи XmlWriter.
WriteObject(Stream, Object)	Записывает полное содержимое объекта (начало записи, запись содержимого и завершение записи) в XML-документ или поток с помощью указанного средства записи Stream.
WriteObject(XmlDictionaryWriter, Object)	Записывает полное содержимое объекта (начало записи, запись содержимого и завершение записи) в XML-документ или поток с помощью указанного средства записи XmlDictionaryWriter.
WriteObject(XmlWriter, Object)	Записывает полное содержимое объекта (начало записи, запись содержимого и завершение записи) в XML-документ или поток с помощью указанного средства записи XmlWriter.
WriteObjectContent(XmlDictionaryWriter, Object)	Записывает только содержимое объекта в XML-документ или XML-поток с помощью указанного средства записи XmlDictionaryWriter.
WriteObjectContent(XmlWriter, Object)	Записывает только содержимое объекта в XML-документ или XML-поток с помощью указанного средства записи XmlWriter.
WriteStartObject(XmlDictionaryWriter, Object)	Записывает начальный элемент данных объекта в качестве открывающего XML-элемента с помощью указанного средства записи XmlDictionaryWriter.
WriteStartObject(XmlWriter, Object)	Записывает начальный элемент данных объекта в качестве открывающего XML-элемента с помощью указанного средства записи XmlWriter.

Применяется к

Бөлісу құралы: