を使用してXMLを最初から作成するとXmlDocument
、OuterXml
プロパティにはすでにすべてが改行で適切にインデントされています。ただし、LoadXml
非常に「圧縮された」XML(改行やインデントなし)を呼び出すと、の出力はOuterXml
そのままになります。それで ...
のインスタンスから美化されたXML出力を取得する最も簡単な方法は何XmlDocument
ですか?
を使用してXMLを最初から作成するとXmlDocument
、OuterXml
プロパティにはすでにすべてが改行で適切にインデントされています。ただし、LoadXml
非常に「圧縮された」XML(改行やインデントなし)を呼び出すと、の出力はOuterXml
そのままになります。それで ...
のインスタンスから美化されたXML出力を取得する最も簡単な方法は何XmlDocument
ですか?
他の回答に基づいて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();
}
これは私が望んでいたよりも少し多くのコードですが、うまく機能します。
Erika Ehrliのブログから引用したように、これは次のことを行う必要があります。
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);
}
短い拡張メソッド バージョン
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();
}
上記の 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;
}
}
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;
}
}
ここに投稿された提案を実装するときに、テキストのエンコードに問題がありました。のエンコーディング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 が、指定されたテキスト エンコーディングでディスクに保存されます。
簡単な方法は、次を使用することです。
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 など、通常慣れている方法でタブまたは改行を追加できます。
すぐに使用できるドキュメントではなく、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();
}