web-dev-qa-db-ja.com

XmlDocumentから改行でインデントされたXMLを取得する最も簡単な方法は何ですか？

XmlDocumentを使用してXMLをゼロから構築すると、OuterXmlプロパティには既に改行で適切にインデントされたすべてのものが含まれています。ただし、非常に「圧縮された」XML（改行やインデントなし）でLoadXmlを呼び出すと、OuterXmlの出力はそのままになります。そう ...

XmlDocumentのインスタンスから美化されたXML出力を取得する最も簡単な方法は何ですか？

c#.netxmldocumentouterxml
101
Neil C. Obremski

他の回答に基づいて、XmlTextWriterを調査し、次のヘルパーメソッドを考え出しました。

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();
}

それは私が望んでいたよりも少し多くのコードですが、それはただうまく機能します。

201
Neil C. Obremski

Erika Ehrli's ブログから改編されたように、これはそれを行うべきです：

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);
}
45
DocMax

または、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);
}
39
JFK

短い拡張メソッドバージョン

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();
}
16
Jonathan Mitchem

上記のBeautifyメソッドが、既にXmlDocument子ノードを含むXmlProcessingInstructionに対して呼び出されている場合、次の例外がスローされます。

XML宣言を書き込めません。 WriteStartDocumentメソッドは既に書き込み済みです。

これは、例外を取り除くために元のバージョンを修正したものです。

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();
    }
}

今ではうまくいきます。おそらく、最初のノードだけでなく、XmlProcessingInstructionノードのすべての子ノードをスキャンする必要がありますか？

2015年4月更新：

エンコーディングが間違っている別のケースがあったので、BOMなしでUTF-8を実施する方法を探しました。 このブログ投稿 を見つけ、それに基づいて関数を作成しました：

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;
    }
}
11
Uwe Keim
XmlTextWriter xw = new XmlTextWriter(writer);
xw.Formatting = Formatting.Indented;
7
benPearce
    public static string FormatXml(string xml)
    {
        try
        {
            var doc = XDocument.Parse(xml);
            return doc.ToString();
        }
        catch (Exception)
        {
            return xml;
        }
    }
5
rewrew

簡単な方法は以下を使用することです：

writer.WriteRaw(space_char);

このサンプルコードのように、このコードは、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();

            }

        }

この方法では、通常の方法でタブまたは改行を追加できます。つまり、\ tまたは\ n

2
Munim Dibosh

受け入れられた答えに基づくより単純化されたアプローチ：

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(); 
}

新しい行を設定する必要はありません。インデント文字にもデフォルトの2つのスペースがあるため、設定しないことをお勧めします。

1
d.i.joe

すぐに使用できるドキュメントではなく、XMLの文字列がある場合は、次の方法で実行できます。

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();
}
1
theJerm

ここに投稿された提案を実装するとき、テキストのエンコードに問題がありました。 XmlWriterSettingsのエンコーディングは無視され、常にストリームのエンコーディングによってオーバーライドされるようです。 StringBuilderを使用する場合、これは常にC＃で内部的に使用されるテキストエンコーディング、つまりUTF-16です。

したがって、他のエンコーディングもサポートするバージョンがあります。

重要な注意：ドキュメントの読み込み時にXMLDocumentオブジェクトのpreserveWhitespaceプロパティが有効になっている場合、フォーマットは完全に無視されます。これにはしばらく困惑していましたので、有効にしないでください。

私の最終的なコード：

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);
    }
}

これにより、指定されたテキストエンコーディングで、フォーマットされたxmlがディスクに保存されます。

1
Nyerguds