XmlWriter Class - .NET API Reference

Provides a fast, forward-only way to send stream of XML documents.

This class is abstract and should be inherited from. Use XmlWriter.Create to create an instance of XmlWriter.

Members

public static System.Xml.XmlWriter Create(System.IO.Stream output)

Creates an XmlWriter that sends XML data to the specified stream.

public static System.Xml.XmlWriter Create(System.IO.Stream output, System.Xml.XmlWriterSettings settings)

Creates an XmlWriter that sends XML data to the specified stream with the specified settings.

public static System.Xml.XmlWriter Create(System.IO.TextWriter output)

Creates an XmlWriter that sends XML data to the specified text writer.

public static System.Xml.XmlWriter Create(System.IO.TextWriter output, System.Xml.XmlWriterSettings settings)

Creates an XmlWriter that sends XML data to the specified text writer with the specified settings.

public abstract void WriteStartDocument()

Writes the XML declaration, such as <?xml version="1.0" encoding="UTF-8"?>.

public abstract void WriteStartElement(string prefix, string localName, string ns)

Writes the start tag for the specified element.

public abstract void WriteEndElement()

Writes the end tag for the current element.

public abstract void WriteString(string text)

Writes the specified string content.

public abstract void WriteAttributeString(string prefix, string localName, string ns, string value)

Writes an attribute with the specified value.

public abstract void Close()

Closes this stream and flushes any buffered data.

Remarks

The XmlWriter class provides a mechanism for writing XML documents. It is designed for performance and efficient writing of XML data. You can control the formatting, indentation, and other aspects of the XML output by using XmlWriterSettings.

Key features include:

Forward-only operation: Data is written sequentially.
Performance: Optimized for speed.
Flexibility: Supports various output formats and settings.

Example Usage

                
using System;
using System.IO;
using System.Xml;

public class Example
{
    public static void Main(string[] args)
    {
        // Create XmlWriterSettings to specify indentation
        XmlWriterSettings settings = new XmlWriterSettings();
        settings.Indent = true;
        settings.IndentChars = "    "; // Use 4 spaces for indentation

        // Create an XmlWriter to write to a string
        using (StringWriter sw = new StringWriter())
        {
            using (XmlWriter writer = XmlWriter.Create(sw, settings))
            {
                writer.WriteStartDocument();
                writer.WriteStartElement("root");
                writer.WriteAttributeString("version", "1.0");

                writer.WriteStartElement("child");
                writer.WriteString("Hello, XML!");
                writer.WriteEndElement(); // End child

                writer.WriteEndElement(); // End root
                writer.WriteEndDocument();
            }
            Console.WriteLine(sw.ToString());
        }
    }
}
                
            