Writes the given object instance to an XML file. - CSharp System.Xml

CSharp examples for System.Xml:XML File

  1. HOME
  2. CSharp
  3. System.Xml
  4. XML File

Description

Writes the given object instance to an XML file.

Demo Code


using System.Xml.Serialization;
using System.Threading.Tasks;
using System.Text;
using System.Linq;
using System.IO;//from  www.  j a va2  s .  c  o  m
using System.Collections.Generic;
using System;

public class Main{
        /// <summary>
        /// Writes the given object instance to an XML file.
        /// <para>Only Public properties and variables will be written to the file. These can be any type though, even other classes.</para>
        /// <para>If there are public properties/variables that you do not want written to the file, decorate them with the [XmlIgnore] attribute.</para>
        /// <para>Object type must have a parameterless constructor.</para>
        /// </summary>
        /// <typeparam name="T">The type of object being written to the file.</typeparam>
        /// <param name="filePath">The file path to write the object instance to.</param>
        /// <param name="objectToWrite">The object instance to write to the file.</param>
        /// <param name="append">If false the file will be overwritten if it already exists. If true the contents will be appended to the file.</param>
        public static void WriteToXmlFile<T>(string filePath, T objectToWrite, bool append = false) where T : new()
        {
            FileWriter.IsFileLocked(filePath);
            TextWriter writer = null;
            try
            {
                var serializer = new XmlSerializer(typeof(T));
                writer = new StreamWriter(filePath, append);
                serializer.Serialize(writer, objectToWrite);
            }
            finally
            {
                if (writer != null)
                    writer.Close();
            }
        }
}

Related Tutorials