Working with XML in C#: Reading and Writing Files with Examples (2024)

Introduction:

XML stands for Extensible Markup Language, it is a popular data exchange format that is widely used in web applications. XML files can be used to store, transport, and exchange data in a structured format. In this article, we will explore how to read and write XML files in C#. We will start with an introduction to XML and then move on to exploring the different ways to read and write XML files using C#.

What is XML?

XML is a markup language that is used to store and transport data in a structured format. It stands for Extensible Markup Language because it allows developers to define their own custom tags and attributes to create structured data. XML files can be used to store a wide variety of data, including text, images, videos, and more. XML files are widely used in web applications because they are platform-independent and can be easily parsed and manipulated using standard libraries.

Creating an XML File:

Before we start reading and writing XML files in C#, we need to create an XML file that we can work with. We can create an XML file using any text editor, such as Notepad or Visual Studio Code. An XML file typically consists of a header, a root element, and child elements. The root element is the top-level element in the XML file, and all other elements are nested within it. Here is an example of a simple XML file:

<?xml version="1.0" encoding="UTF-8"?><books> <book> <title>Programming C#</title> <author>John Doe</author> <publisher>O'Reilly</publisher> <price>29.99</price> </book> <book> <title>Database Design</title> <author>Jane Doe</author> <publisher>Wiley</publisher> <price>39.99</price> </book></books>

This XML file represents a collection of books, each of which has a title, author, publisher, and price.

Reading an XML File in C#:

Now that we have an XML file to work with, let's explore how to read its contents using C#. C# provides several ways to read XML files, including using the XmlDocument and XmlReader classes.

Using the XmlDocument Class:

The XmlDocument class is part of the System.Xml namespace and provides a convenient way to read and manipulate XML documents. We can use the Load method of the XmlDocument class to load an XML file into memory, and then use the SelectNodes method to retrieve specific elements from the XML file.

Here is an example of how to read the contents of an XML file using the XmlDocument class:

using System;using System.Xml;class Program{ static void Main(string[] args) { XmlDocument xmlDoc = new XmlDocument(); xmlDoc.Load("books.xml"); XmlNodeList bookNodes = xmlDoc.SelectNodes("//book"); foreach (XmlNode bookNode in bookNodes) { string title = bookNode.SelectSingleNode("title").InnerText; string author = bookNode.SelectSingleNode("author").InnerText; string publisher = bookNode.SelectSingleNode("publisher").InnerText; double price = Convert.ToDouble(bookNode.SelectSingleNode("price").InnerText); Console.WriteLine("Title: {0}", title); Console.WriteLine("Author: {0}", author); Console.WriteLine("Publisher: {0}", publisher); Console.WriteLine("Price: {0:C}", price); } }}

In this example, we create an instance of the XmlDocument class and load the "books.xml" file into memory. We then use the SelectNodes method to retrieve all the "book" elements from the XML file. We iterate over each "book" element and use theSelectSingleNode method to retrieve the values of the "title", "author", "publisher", and "price" elements. We convert the "price" value to a double and then output all the values to the console.

Using the XmlReader Class:

The XmlReader class is another way to read XML files in C#. It is a fast and efficient way to read large XML files because it only reads one element at a time, rather than loading the entire file into memory.

Here is an example of how to read an XML file using the XmlReader class:

using System;using System.Xml;class Program{ static void Main(string[] args) { using (XmlReader reader = XmlReader.Create("books.xml")) { while (reader.Read()) { if (reader.NodeType == XmlNodeType.Element && reader.Name == "book") { string title = reader.GetAttribute("title"); string author = reader.GetAttribute("author"); string publisher = reader.GetAttribute("publisher"); double price = Convert.ToDouble(reader.GetAttribute("price")); Console.WriteLine("Title: {0}", title); Console.WriteLine("Author: {0}", author); Console.WriteLine("Publisher: {0}", publisher); Console.WriteLine("Price: {0:C}", price); } } } }}

In this example, we create an instance of the XmlReader class and pass the name of the XML file to the Create method. We then loop through the contents of the XML file using the Read method of the XmlReader class. We use the NodeType and Name properties to check if the current element is a "book" element, and if it is, we use the GetAttribute method to retrieve the values of the "title", "author", "publisher", and "price" attributes. We convert the "price" value to a double and then output all the values to the console.

Writing an XML File in C#:

Now that we know how to read XML files in C#, let's explore how to write XML files. C# provides several ways to write XML files, including using the XmlDocument and XmlWriter classes.

Using the XmlDocument Class:

We can use the XmlDocument class to create a new XML document and then use its various methods to add elements and attributes to the document. Once we have created the XML document, we can save it to a file using the Save method.

Here is an example of how to create a new XML document using the XmlDocument class and save it to a file:

using System;using System.Xml;class Program{ static void Main(string[] args) { XmlDocument xmlDoc = new XmlDocument(); XmlNode booksNode = xmlDoc.CreateElement("books"); xmlDoc.AppendChild(booksNode); XmlNode bookNode = xmlDoc.CreateElement("book"); booksNode.AppendChild(bookNode); XmlAttribute titleAttribute = xmlDoc.CreateAttribute("title"); titleAttribute.Value = "Programming C#"; bookNode.Attributes.Append(titleAttribute); XmlAttribute authorAttribute = xmlDoc.CreateAttribute("author"); authorAttribute.Value = "John Doe"; bookNode.Attributes.Append(authorAttribute); XmlAttribute publisherAttribute = xmlDoc.CreateAttribute("publisher"); publisherAttribute.Value = "O'Reilly"; bookNode.Attributes.Append(publisherAttribute); XmlAttribute priceAttribute = xmlDoc.CreateAttribute("price"); priceAttribute.Value = "29.99"; bookNode.Attributes.Append(priceAttribute); xmlDoc.Save("newbooks.xml"); }}

In this example, we create an instance of the XmlDocument class and then create a new "books" element using the CreateElement method. We append the "books" element to the XMLdocument using the AppendChild method.

We then create a new "book" element using the CreateElement method and append it to the "books" element using the AppendChild method. We create four attributes for the "book" element using the CreateAttribute method, set their values, and append them to the "book" element using the Append method.

Finally, we save the XML document to a file using the Save method.

Using the XmlWriter Class:

The XmlWriter class is another way to write XML files in C#. It provides a more efficient way to create large XML files because it writes the XML data directly to a file, rather than creating an entire XML document in memory.

Here is an example of how to create an XML file using the XmlWriter class:

using System;using System.Xml;class Program{ static void Main(string[] args) { XmlWriterSettings settings = new XmlWriterSettings(); settings.Indent = true; using (XmlWriter writer = XmlWriter.Create("newbooks.xml", settings)) { writer.WriteStartElement("books"); writer.WriteStartElement("book"); writer.WriteAttributeString("title", "Programming C#"); writer.WriteAttributeString("author", "John Doe"); writer.WriteAttributeString("publisher", "O'Reilly"); writer.WriteAttributeString("price", "29.99"); writer.WriteEndElement(); writer.WriteEndElement(); } }}

In this example, we create an instance of the XmlWriter class and pass the name of the XML file and an XmlWriterSettings object to the Create method. We then use the WriteStartElement method to create the "books" element and the WriteAttributeString method to create the attributes for the "book" element. Finally, we use the WriteEndElement method to close the "book" and "books" elements.

Conclusion:

In this article, we have explored how to read and write XML files in C# using various classes provided by the .NET Framework. We have seen how to use the XmlDocument and XmlReader classes to read XML files, and how to use the XmlWriter class to write XML files.

XML is an important format for exchanging data between systems and applications, and C# provides a powerful set of tools for working with XML data. By using these tools, we can create robust and flexible applications that can easily read and write XML files, and integrate with other systems that use XML data.