Jaki jest najprostszy sposób uzyskania kodu XML z wcięciem i podziałami wierszy z XmlDocument?

Kiedy tworzę XML od podstaw XmlDocument, OuterXmlwłaściwość ma już wszystko ładnie wcięte z podziałami linii. Jednakże, jeśli użyję LoadXmljakiegoś bardzo „skompresowanego” XML-a (bez podziałów wierszy lub wcięć), wtedy wynik działania OuterXmlpozostaje taki. Więc ...

Jaki jest najprostszy sposób uzyskania upiększonych danych wyjściowych XML z wystąpienia programu XmlDocument?

Na podstawie innych odpowiedzi przyjrzałem się XmlTextWriteri opracowałem następującą metodę pomocniczą:

static public string Beautify(this XmlDocument doc)
{
    StringBuilder sb = new StringBuilder();
    XmlWriterSettings settings = new XmlWriterSettings
    {
        Indent = true,
        IndentChars = "  ",
        NewLineChars = "\r\n",
        NewLineHandling = NewLineHandling.Replace
    };
    using (XmlWriter writer = XmlWriter.Create(sb, settings)) {
        doc.Save(writer);
    }
    return sb.ToString();
}

To trochę więcej kodu, niż się spodziewałem, ale działa po prostu brzoskwiniowo.

Zgodnie z adaptacją z bloga Eriki Ehrli powinno to wystarczyć:

XmlDocument doc = new XmlDocument();
doc.LoadXml("<item><name>wrench</name></item>");
// Save the document to a file and auto-indent the output.
using (XmlTextWriter writer = new XmlTextWriter("data.xml", null)) {
    writer.Formatting = Formatting.Indented;
    doc.Save(writer);
}

Lub nawet łatwiej, jeśli masz dostęp do Linq

try
{
    RequestPane.Text = System.Xml.Linq.XElement.Parse(RequestPane.Text).ToString();
}
catch (System.Xml.XmlException xex)
{
            displayException("Problem with formating text in Request Pane: ", xex);
}

Krótsza wersja metody rozszerzenia

public static string ToIndentedString( this XmlDocument doc )
{
    var stringWriter = new StringWriter(new StringBuilder());
    var xmlTextWriter = new XmlTextWriter(stringWriter) {Formatting = Formatting.Indented};
    doc.Save( xmlTextWriter );
    return stringWriter.ToString();
}

Jeśli powyższa metoda Beautify jest wywoływana dla elementu, XmlDocumentktóry już zawiera XmlProcessingInstructionwęzeł podrzędny, generowany jest następujący wyjątek:

Nie można zapisać deklaracji XML. Metoda WriteStartDocument już go zapisała.

To jest moja zmodyfikowana wersja oryginalnej, aby pozbyć się wyjątku:

private static string beautify(
    XmlDocument doc)
{
    var sb = new StringBuilder();
    var settings =
        new XmlWriterSettings
            {
                Indent = true,
                IndentChars = @"    ",
                NewLineChars = Environment.NewLine,
                NewLineHandling = NewLineHandling.Replace,
            };

    using (var writer = XmlWriter.Create(sb, settings))
    {
        if (doc.ChildNodes[0] is XmlProcessingInstruction)
        {
            doc.RemoveChild(doc.ChildNodes[0]);
        }

        doc.Save(writer);
        return sb.ToString();
    }
}

U mnie teraz działa, prawdopodobnie musiałbyś przeskanować wszystkie węzły potomne XmlProcessingInstruction, a nie tylko pierwszy?

Aktualizacja kwiecień 2015:

Ponieważ miałem inny przypadek, w którym kodowanie było nieprawidłowe, szukałem sposobu na wymuszenie UTF-8 bez BOM. Znalazłem ten post na blogu i utworzyłem na jego podstawie funkcję:

private static string beautify(string xml)
{
    var doc = new XmlDocument();
    doc.LoadXml(xml);

    var settings = new XmlWriterSettings
    {
        Indent = true,
        IndentChars = "\t",
        NewLineChars = Environment.NewLine,
        NewLineHandling = NewLineHandling.Replace,
        Encoding = new UTF8Encoding(false)
    };

    using (var ms = new MemoryStream())
    using (var writer = XmlWriter.Create(ms, settings))
    {
        doc.Save(writer);
        var xmlString = Encoding.UTF8.GetString(ms.ToArray());
        return xmlString;
    }
}

XmlTextWriter xw = new XmlTextWriter(writer);
xw.Formatting = Formatting.Indented;

    public static string FormatXml(string xml)
    {
        try
        {
            var doc = XDocument.Parse(xml);
            return doc.ToString();
        }
        catch (Exception)
        {
            return xml;
        }
    }

Prostym sposobem jest użycie:

writer.WriteRaw(space_char);

Podobnie jak w tym przykładowym kodzie, ten kod jest tym, czego użyłem do utworzenia struktury podobnej do widoku drzewa przy użyciu XMLWriter:

private void generateXML(string filename)
        {
            using (XmlWriter writer = XmlWriter.Create(filename))
            {
                writer.WriteStartDocument();
                //new line
                writer.WriteRaw("\n");
                writer.WriteStartElement("treeitems");
                //new line
                writer.WriteRaw("\n");
                foreach (RootItem root in roots)
                {
                    //indent
                    writer.WriteRaw("\t");
                    writer.WriteStartElement("treeitem");
                    writer.WriteAttributeString("name", root.name);
                    writer.WriteAttributeString("uri", root.uri);
                    writer.WriteAttributeString("fontsize", root.fontsize);
                    writer.WriteAttributeString("icon", root.icon);
                    if (root.children.Count != 0)
                    {
                        foreach (ChildItem child in children)
                        {
                            //indent
                            writer.WriteRaw("\t");
                            writer.WriteStartElement("treeitem");
                            writer.WriteAttributeString("name", child.name);
                            writer.WriteAttributeString("uri", child.uri);
                            writer.WriteAttributeString("fontsize", child.fontsize);
                            writer.WriteAttributeString("icon", child.icon);
                            writer.WriteEndElement();
                            //new line
                            writer.WriteRaw("\n");
                        }
                    }
                    writer.WriteEndElement();
                    //new line
                    writer.WriteRaw("\n");
                }

                writer.WriteEndElement();
                writer.WriteEndDocument();

            }

        }

W ten sposób możesz dodawać znaki tabulacji lub podziały wierszy w zwykły sposób, tj. \ T lub \ n

Wdrażając zamieszczone tutaj sugestie, miałem problem z kodowaniem tekstu. Wygląda na to, że kodowanie XmlWriterSettingsjest ignorowane i zawsze zastępowane przez kodowanie strumienia. W przypadku używania a StringBuilderjest to zawsze kodowanie tekstu używane wewnętrznie w C #, a mianowicie UTF-16.

Oto wersja, która obsługuje również inne kodowania.

WAŻNA UWAGA: Formatowanie jest całkowicie ignorowane, jeśli XMLDocumentobiekt ma preserveWhitespacewłączoną właściwość podczas ładowania dokumentu. Przez chwilę byłem zaskoczony, więc nie włączaj tego.

Mój ostateczny kod:

public static void SaveFormattedXml(XmlDocument doc, String outputPath, Encoding encoding)
{
    XmlWriterSettings settings = new XmlWriterSettings();
    settings.Indent = true;
    settings.IndentChars = "\t";
    settings.NewLineChars = "\r\n";
    settings.NewLineHandling = NewLineHandling.Replace;

    using (MemoryStream memstream = new MemoryStream())
    using (StreamWriter sr = new StreamWriter(memstream, encoding))
    using (XmlWriter writer = XmlWriter.Create(sr, settings))
    using (FileStream fileWriter = new FileStream(outputPath, FileMode.Create))
    {
        if (doc.ChildNodes.Count > 0 && doc.ChildNodes[0] is XmlProcessingInstruction)
            doc.RemoveChild(doc.ChildNodes[0]);
        // save xml to XmlWriter made on encoding-specified text writer
        doc.Save(writer);
        // Flush the streams (not sure if this is really needed for pure mem operations)
        writer.Flush();
        // Write the underlying stream of the XmlWriter to file.
        fileWriter.Write(memstream.GetBuffer(), 0, (Int32)memstream.Length);
    }
}

Spowoduje to zapisanie sformatowanego pliku XML na dysku z podanym kodowaniem tekstu.

Jeśli masz ciąg XML, a nie dokument gotowy do użycia, możesz to zrobić w ten sposób:

var xmlString = "<xml>...</xml>"; // Your original XML string that needs indenting.
xmlString = this.PrettifyXml(xmlString);

private string PrettifyXml(string xmlString)
{
    var prettyXmlString = new StringBuilder();

    var xmlDoc = new XmlDocument();
    xmlDoc.LoadXml(xmlString);

    var xmlSettings = new XmlWriterSettings()
    {
        Indent = true,
        IndentChars = " ",
        NewLineChars = "\r\n",
        NewLineHandling = NewLineHandling.Replace
    };

    using (XmlWriter writer = XmlWriter.Create(prettyXmlString, xmlSettings))
    {
        xmlDoc.Save(writer);
    }

    return prettyXmlString.ToString();
}

Bardziej uproszczone podejście oparte na zaakceptowanej odpowiedzi:

static public string Beautify(this XmlDocument doc) {
    StringBuilder sb = new StringBuilder();
    XmlWriterSettings settings = new XmlWriterSettings
    {
        Indent = true
    };

    using (XmlWriter writer = XmlWriter.Create(sb, settings)) {
        doc.Save(writer);
    }

    return sb.ToString(); 
}

Ustawienie nowej linii nie jest konieczne. Znaki wcięcia mają również domyślne dwie spacje, więc wolałem też ich nie ustawiać.