Table of Contents

XmlSerializer Class

Definition

Namespace
Cuemon.Xml.Serialization
Assemblies
Cuemon.Xml.dll
Source
src/Cuemon.Xml/Serialization/XmlSerializer.cs

Serializes and deserializes objects into and from the XML format.

public class XmlSerializer
Inheritance
XmlSerializer

Examples

The following example demonstrates how to serialize and deserialize a simple object with .

using System;
using Cuemon.Xml.Serialization;

namespace MyApp.Examples;

public static class XmlSerializerExample
{
    public static void Demonstrate()
    {
        var serializer = XmlSerializer.Create(new XmlSerializerOptions
        {
            RootName = new XmlQualifiedEntity("Order")
        });

        var order = new Order
        {
            Id = 1001,
            Customer = "John Doe",
            Total = 299.99m
        };

        using var stream = serializer.Serialize(order, typeof(Order));
        stream.Position = 0;

        var deserialized = serializer.Deserialize<Order>(stream);

        Console.WriteLine(deserialized.Customer);
        Console.WriteLine(deserialized.Total);
    }

    private sealed class Order
    {
        public int Id { get; set; }

        public string Customer { get; set; }

        public decimal Total { get; set; }
    }
}

Methods

Name Description
Create(XmlSerializerOptions)

Creates a new XmlSerializer instance using the specified XmlSerializerOptions.

Deserialize(Stream, Type)

Deserializes the specified value into an object of objectType.

Deserialize<T>(Stream)

Deserializes the specified value into an object of T.

Serialize(object, Type)

Serializes the specified value to a Stream.