Question

我知道有很多关于此主题的帖子，但是似乎没有一个帖子可以处理这个特定问题。我正在尝试制作一个小型的通用文档生成器POC。我正在使用Open XML。

代码如下：

   private static void ReplacePlaceholders<T>(string templateDocumentPath, T templateObject)
        where T : class
    {

        using (var templateDocument = WordprocessingDocument.Open(templateDocumentPath, true))
        {
            string templateDocumentText = null;
            using (var streamReader = new StreamReader(templateDocument.MainDocumentPart.GetStream()))
            {
                templateDocumentText = streamReader.ReadToEnd();
            }

            var props = templateObject.GetType().GetProperties();
            foreach (var prop in props)
            {
                var regexText = new Regex($"{prop.Name}");
                templateDocumentText =
                    regexText.Replace(templateDocumentText, prop.GetValue(templateObject).ToString());
            }

            using var streamWriter = new StreamWriter(templateDocument.MainDocumentPart.GetStream(FileMode.Create));
                streamWriter.Write(templateDocumentText);
        }
    }

代码按预期工作。 问题如下：

StreamReader.ReadToEnd（）在标签之间分割我的占位符，所以我的Replace方法仅替换不会被分割的单词。

在这种情况下，我的代码将搜索单词“ Firstname”，但会找到“ irstname”，因此不会替换它。

有没有办法逐字扫描整个.docx并替换它们？

（编辑）部分解决方案/解决方法，我发现： -我注意到您必须立即在.docx中写入占位符（无需重新编辑）。例如，如果我写“ firstname”，然后再将其修改为“ Firstname”，它将把单词拆分为“ F”“ irstname”。如果没有editng，它将不会分裂。

Answer 1

TLDR

简而言之，解决问题的方法是使用Open-Xml-PowerTools的OpenXmlRegex实用程序类，如下面进一步的单元测试所示。

为什么？

使用Open XML，您可以通过多种方式表示相同的文本。如果Microsoft Word参与了该Open XML标记的创建，则为产生该文本而进行的编辑将发挥重要作用。这是因为Word会跟踪在哪个编辑会话中进行了哪些编辑。因此，例如，在以下极端情况下显示的w:p（Paragraph）元素表示的文本完全相同。这两个示例之间的任何事情都是可能的，因此任何真正的解决方案都必须能够解决这一问题。

极端情况1：单个`w:r`和`w:t`元素

以下标记非常简单：

<w:p>
  <w:r>
    <w:t>Firstname</w:t>
  </w:r>
</w:p>

极端情况2：单字符`w:r`和`w:t`元素

虽然通常不会找到以下标记，但它表示每个字符都有其自己的w:r和w:t元素的理论极限。

<w:p>
  <w:r>
    <w:t>F</w:t>
    <w:t>i</w:t>
    <w:t>r</w:t>
    <w:t>s</w:t>
    <w:t>t</w:t>
    <w:t>n</w:t>
    <w:t>a</w:t>
    <w:t>m</w:t>
    <w:t>e</w:t>
  </w:r>
</w:p>

您可能会问，为什么在实践中没有出现这个极端示例？答案是，如果您想自己动手，它在解决方案中起着至关重要的作用。

如何滚动您自己的？

要正确执行此操作，您必须：

将段落（w:r）的运行（w:p）转换为单字符运行（即，w:r元素具有一个单字符w:t或一个{每个{1}}，保留运行属性（w:sym）;
在这些单字符运行中执行搜索和替换操作（使用其他一些技巧）；和
考虑到搜索和替换操作所导致的运行的潜在不同运行属性（w:rPr），将这种运行结果转换回代表文本及其文本所需的最少“合并”运行次数格式。

替换文本时，不应丢失或更改不受替换影响的文本格式。您也不应删除不受影响的字段或内容控件（w:rPr）。嗯，顺便说一句，不要忘记诸如w:sdt和w:ins之类的修订标记...

为什么不自己动手？

好消息是您不必自己动手。埃里克·怀特（Eric White）的Open-Xml-PowerTools的w:del实用工具类实现了上述算法（以及更多）。我已经在大型RFP和签约场景中成功使用了它，并且对此做出了贡献。

如何使用OPEN-XML-POWERTOOLS？

在本节中，我将演示如何使用Open-Xml-PowerTools将占位符文本“ Firstname”（如在问题中）替换为示例输出文档中的各种名字（使用“ Bernie”））。

样本输入文档

首先让我们看一下下面的示例文档，该文档是由稍后显示的单元测试创建的。请注意，我们已经格式化了运行和符号。就像在问题中一样，占位符“ Firstname”被分为两个运行，即“ F”和“ irstname”。

OpenXmlRegex

所需的输出文档

以下是正确执行以下操作后将“ Firstname”替换为“ Bernie”的文档。请注意，格式保留不变，并且我们没有丢失符号。

<?xml version="1.0" encoding="utf-8"?>
<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
  <w:body>
    <w:p>
      <w:r>
        <w:rPr>
          <w:i />
        </w:rPr>
        <w:t xml:space="preserve">Hello </w:t>
      </w:r>
      <w:r>
        <w:rPr>
          <w:b />
        </w:rPr>
        <w:t>F</w:t>
      </w:r>
      <w:r>
        <w:rPr>
          <w:b />
        </w:rPr>
        <w:t>irstname</w:t>
      </w:r>
      <w:r>
        <w:t xml:space="preserve"> </w:t>
      </w:r>
      <w:r>
        <w:sym w:font="Wingdings" w:char="F04A" />
      </w:r>
    </w:p>
  </w:body>
</w:document>

样品用量

接下来，这是一个完整的单元测试，演示了如何使用<?xml version="1.0" encoding="utf-8"?> <w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"> <w:body> <w:p> <w:r> <w:rPr> <w:i /> </w:rPr> <w:t xml:space="preserve">Hello </w:t> </w:r> <w:r> <w:rPr> <w:b /> </w:rPr> <w:t>Bernie</w:t> </w:r> <w:r> <w:t xml:space="preserve"> </w:t> </w:r> <w:r> <w:sym w:font="Wingdings" w:char="F04A" /> </w:r> </w:p> </w:body> </w:document>方法，并注意该示例仅显示了多个重载之一。单元测试还证明了这一点：

无论占位符（例如“ Firstname”）如何在一个或多个运行中分配；
同时保留占位符的格式；
在不丢失其他运行格式的情况下；和
不丢失符号（或其他任何标记，例如字段或内容控件）。

OpenXmlRegex.Replace()

为什么不是内文解决方案？

虽然可能很想使用[Theory] [InlineData("1 Run", "Firstname", new[] { "Firstname" }, "Albert")] [InlineData("2 Runs", "Firstname", new[] { "F", "irstname" }, "Bernie")] [InlineData("9 Runs", "Firstname", new[] { "F", "i", "r", "s", "t", "n", "a", "m", "e" }, "Charly")] public void Replace_PlaceholderInOneOrMoreRuns_SuccessfullyReplaced( string example, string propName, IEnumerable<string> runTexts, string replacement) { // Create a test WordprocessingDocument on a MemoryStream. using MemoryStream stream = CreateWordprocessingDocument(runTexts); // Save the Word document before replacing the placeholder. // You can use this to inspect the input Word document. File.WriteAllBytes($"{example} before Replacing.docx", stream.ToArray()); // Replace the placeholder identified by propName with the replacement text. using (WordprocessingDocument wordDocument = WordprocessingDocument.Open(stream, true)) { // Read the root element, a w:document in this case. // Note that GetXElement() is a shortcut for GetXDocument().Root. // This caches the root element and we can later write it back // to the main document part, using the PutXDocument() method. XElement document = wordDocument.MainDocumentPart.GetXElement(); // Specify the parameters of the OpenXmlRegex.Replace() method, // noting that the replacement is given as a parameter. IEnumerable<XElement> content = document.Descendants(W.p); var regex = new Regex(propName); // Perform the replacement, thereby modifying the root element. OpenXmlRegex.Replace(content, regex, replacement, null); // Write the changed root element back to the main document part. wordDocument.MainDocumentPart.PutXDocument(); } // Assert that we have done it right. AssertReplacementWasSuccessful(stream, replacement); // Save the Word document after having replaced the placeholder. // You can use this to inspect the output Word document. File.WriteAllBytes($"{example} after Replacing.docx", stream.ToArray()); } private static MemoryStream CreateWordprocessingDocument(IEnumerable<string> runTexts) { var stream = new MemoryStream(); const WordprocessingDocumentType type = WordprocessingDocumentType.Document; using (WordprocessingDocument wordDocument = WordprocessingDocument.Create(stream, type)) { MainDocumentPart mainDocumentPart = wordDocument.AddMainDocumentPart(); mainDocumentPart.PutXDocument(new XDocument(CreateDocument(runTexts))); } return stream; } private static XElement CreateDocument(IEnumerable<string> runTexts) { // Produce a w:document with a single w:p that contains: // (1) one italic run with some lead-in, i.e., "Hello " in this example; // (2) one or more bold runs for the placeholder, which might or might not be split; // (3) one run with just a space; and // (4) one run with a symbol (i.e., a Wingdings smiley face). return new XElement(W.document, new XAttribute(XNamespace.Xmlns + "w", "http://schemas.openxmlformats.org/wordprocessingml/2006/main"), new XElement(W.body, new XElement(W.p, new XElement(W.r, new XElement(W.rPr, new XElement(W.i)), new XElement(W.t, new XAttribute(XNamespace.Xml + "space", "preserve"), "Hello ")), runTexts.Select(rt => new XElement(W.r, new XElement(W.rPr, new XElement(W.b)), new XElement(W.t, rt))), new XElement(W.r, new XElement(W.t, new XAttribute(XNamespace.Xml + "space", "preserve"), " ")), new XElement(W.r, new XElement(W.sym, new XAttribute(W.font, "Wingdings"), new XAttribute(W._char, "F04A")))))); } private static void AssertReplacementWasSuccessful(MemoryStream stream, string replacement) { using WordprocessingDocument wordDocument = WordprocessingDocument.Open(stream, false); XElement document = wordDocument.MainDocumentPart.GetXElement(); XElement paragraph = document.Descendants(W.p).Single(); List<XElement> runs = paragraph.Elements(W.r).ToList(); // We have the expected number of runs, i.e., the lead-in, the first name, // a space character, and the symbol. Assert.Equal(4, runs.Count); // We still have the lead-in "Hello " and it is still formatted in italics. Assert.True(runs[0].Value == "Hello " && runs[0].Elements(W.rPr).Elements(W.i).Any()); // We have successfully replaced our "Firstname" placeholder and the // concrete first name is formatted in bold, exactly like the placeholder. Assert.True(runs[1].Value == replacement && runs[1].Elements(W.rPr).Elements(W.b).Any()); // We still have the space between the first name and the symbol and it // is unformatted. Assert.True(runs[2].Value == " " && !runs[2].Elements(W.rPr).Any()); // Finally, we still have our smiley face symbol run. Assert.True(IsSymbolRun(runs[3], "Wingdings", "F04A")); } private static bool IsSymbolRun(XElement run, string fontValue, string charValue) { XElement sym = run.Elements(W.sym).FirstOrDefault(); if (sym == null) return false; return (string) sym.Attribute(W.font) == fontValue && (string) sym.Attribute(W._char) == charValue; }类（或InnerText类的其他子类）的Paragraph属性，但问题在于您将忽略任何非文字（OpenXmlElement）标记。例如，如果您的段落包含符号（w:t元素，例如上面示例中使用的笑脸），则这些元素将丢失，因为w:sym属性未考虑它们。以下单元测试表明：

InnerText

请注意，在简单的用例中，您可能不需要考虑以上所有内容。但是，如果您必须处理现实生活中的文档或Microsoft Word所做的标记更改，那么您很有可能无法忽略其复杂性。并等到您需要处理修订标记...

与往常一样，完整的源代码可以在我的CodeSnippets GitHub存储库中找到。寻找OpenXmlRegexTests类。

打开XML-在文档模板中查找并替换多个占位符

1 个答案:

TLDR

为什么？

极端情况1：单个`w:r`和`w:t`元素

极端情况2：单字符`w:r`和`w:t`元素

如何滚动您自己的？

为什么不自己动手？

如何使用OPEN-XML-POWERTOOLS？

样本输入文档

所需的输出文档

样品用量

为什么不是内文解决方案？

打开XML-在文档模板中查找并替换多个占位符

1 个答案:

TLDR

为什么？

极端情况1：单个w:r和w:t元素

极端情况2：单字符w:r和w:t元素

如何滚动您自己的？

为什么不自己动手？

如何使用OPEN-XML-POWERTOOLS？

样本输入文档

所需的输出文档

样品用量

为什么不是内文解决方案？

极端情况1：单个`w:r`和`w:t`元素

极端情况2：单字符`w:r`和`w:t`元素