C# 通过模板生成 Word 文档:文本与图片占位符替换完整攻略

在办公自动化开发中,根据固定模板批量生成 Word 文档(如合同、报告、简历、通知书等)是最常见的需求之一。本文将介绍如何使用 Spire.Doc for .NET 组件,通过加载模板文件,将文档中的文本占位符替换为真实数据,并支持将占位符替换为图片,最终生成一份完整的 Word 文档。

为什么选择 Spire.Doc?

Spire.Doc 是一款功能强大的 .NET Word 组件,无需安装 Microsoft Office 即可创建、读取、编辑和转换 Word 文档。它提供了丰富的 API,尤其 Document.Replace() 方法可以快速完成文本替换,而结合 FindString()DocPicture 又能灵活实现图片插入,非常适合模板填充场景。

代码实现步骤

下面通过一个完整的控制台程序示例,演示如何将模板中的 #name##gender# 等占位符替换为实际内容,并将 #photo# 替换为一张图片。

1. 引入命名空间与初始化文档

复制代码
using Spire.Doc;
using Spire.Doc.Documents;
using Spire.Doc.Fields;
using System.Drawing;

创建 Document 对象并加载模板文件(.docx):

复制代码
Document document = new Document();
document.LoadFromFile("Template.docx");

2. 文本占位符替换

建立一个字典,键为占位符(如 #name#),值为真实数据。这里我们将示例内容本地化为中文环境:

复制代码
Dictionary<string, string> replaceDict = new Dictionary<string, string>
{
    { "#name#", "张三" },
    { "#gender#", "男" },
    { "#birthdate#", "1990年1月15日" },
    { "#address#", "上海市浦东新区" },
    { "#city#", "上海" },
    { "#state#", "直辖市" },
    { "#postal#", "200120" },
    { "#country#", "中国" }
};

遍历字典,调用 document.Replace(占位符, 替换值, true, true) 完成全文档替换。后两个布尔参数分别表示是否区分大小写和是否匹配整个单词,这里按需设置。

3. 图片占位符替换

文本替换无法处理图片,因此我们需要单独实现一个方法 ReplaceTextWithImage。其核心逻辑是:

  • Image.FromFile() 加载图片;

  • 创建 DocPicture 对象并载入图片;

  • 通过 document.FindString() 定位占位符 #photo# 所在的 TextRange

  • 获取该 TextRange 在段落子对象中的索引,将图片插入同一位置,然后删除占位符文本。

    static void ReplaceTextWithImage(Document document, string stringToReplace, string imagePath)
    {
    Image image = Image.FromFile(imagePath);
    DocPicture pic = new DocPicture(document);
    pic.LoadImage(image);

    复制代码
      TextSelection selection = document.FindString(stringToReplace, false, true);
      TextRange range = selection.GetAsOneRange();
      int index = range.OwnerParagraph.ChildObjects.IndexOf(range);
    
      range.OwnerParagraph.ChildObjects.Insert(index, pic);
      range.OwnerParagraph.ChildObjects.Remove(range);

    }

调用时传入图片路径:

复制代码
ReplaceTextWithImage(document, "#photo#", "portrait.png");

4. 保存与释放

最后将文档保存为新文件,并释放资源:

复制代码
document.SaveToFile("ReplacePlaceholders.docx", FileFormat.Docx);
document.Dispose();

完整代码一览

复制代码
using Spire.Doc;
using Spire.Doc.Documents;
using Spire.Doc.Fields;
using System.Drawing;

namespace CreateWordByReplacingTextPlaceholders
{
    class Program
    {
        static void Main(string[] args)
        {
            Document document = new Document();
            document.LoadFromFile("Template.docx");

            Dictionary<string, string> replaceDict = new Dictionary<string, string>
            {
                { "#name#", "张三" },
                { "#gender#", "男" },
                { "#birthdate#", "1990年1月15日" },
                { "#address#", "上海市浦东新区" },
                { "#city#", "上海" },
                { "#state#", "直辖市" },
                { "#postal#", "200120" },
                { "#country#", "中国" }
            };

            foreach (var kvp in replaceDict)
            {
                document.Replace(kvp.Key, kvp.Value, true, true);
            }

            ReplaceTextWithImage(document, "#photo#", "portrait.png");

            document.SaveToFile("ReplacePlaceholders.docx", FileFormat.Docx);
            document.Dispose();
        }

        static void ReplaceTextWithImage(Document document, string stringToReplace, string imagePath)
        {
            Image image = Image.FromFile(imagePath);
            DocPicture pic = new DocPicture(document);
            pic.LoadImage(image);

            TextSelection selection = document.FindString(stringToReplace, false, true);
            TextRange range = selection.GetAsOneRange();
            int index = range.OwnerParagraph.ChildObjects.IndexOf(range);

            range.OwnerParagraph.ChildObjects.Insert(index, pic);
            range.OwnerParagraph.ChildObjects.Remove(range);
        }
    }
}

注意事项与扩展

  1. 模板设计 :在 Word 模板中,占位符必须与代码中的字符串完全一致(包括大小写和特殊符号),建议使用明显的标记如 #{``{}} 以避免误替换。
  2. 图片处理ReplaceTextWithImage 方法假设占位符独立存在于一个段落中,若占位符与其他文本同行,插入图片后可能会影响排版,可根据业务调整插入位置。
  3. 性能优化 :对于大量文档生成,可复用 Document 对象,或使用内存流操作。
  4. 字体与样式 :替换文本后,新内容会继承原占位符的样式,如需自定义样式,可操作 TextRangeCharacterFormat 属性。

总结

通过 Spire.Doc 提供的简洁 API,我们仅用几十行代码就实现了 Word 模板的数据填充,既支持文本又支持图片。这种方式极大地提高了文档生成的效率和准确性,非常适合企业级报表、证书打印、批量信函等场景。开发者只需关注模板设计和数据来源,剩下的交给代码即可。

如果你正在寻找轻量级、无 Office 依赖的 Word 操作方案,Spire.Doc 无疑是一个值得尝试的选择。希望本文能帮助你快速上手,为你的项目增添自动化生成文档的能力。

相关推荐
wbs_scy1 小时前
仿 muduo 高并发服务器项目:实现轻量级日志宏,方便后续网络库调试
开发语言·php
Huangjin007_1 小时前
【C++11篇(四)】新的类功能、lambda 与包装器详解
开发语言·c++
2zcode1 小时前
基于MATLAB图像处理的啤酒瓶口缺陷检测系统设计与实现
开发语言·图像处理·matlab
影寂ldy1 小时前
C# 泛型协变与逆变
windows·microsoft·c#
进击的程序猿~1 小时前
Go Zero源码阅读2
开发语言·后端·golang
hdsoft_huge1 小时前
JDK系列19:JVM全维度调优实战,内存、元空间、线程栈、GC参数压测调优完整方案
java·开发语言·jvm
哥不想学算法9 小时前
【C++】字符串字面量拼接
开发语言·c++
gugucoding11 小时前
21. 【C语言】打包不同类型:结构体
c语言·开发语言