你是否經常遇到這樣的場景：產品運營有著大量的報告需求，或者給客戶領導展現每周的運營報告？這些文檔類的任務可以交給運營同事，他們負責文檔排版和樣式，你作為開發人員你只需要提供數據源，和一個映射表，告訴制作文檔的人哪些字段可供使用。這樣一來分工明確，減少了很多不必要的溝通成本。

Document Template Tool

指定一個模板生成word或pdf文件

運行單元測試以查看示例！

功能 & 特點

• 基于占位符的模板，可繼承原有樣式；
• 支持表格；
• 支持數據集合；
• 支持圖片；
• 提供Cli版本程序；
• 可擴展的接口封裝和組件。

快速開始

使用Cli

進入可執行文件所在目錄，在命令提示符中運行DocTemplateTool.exe

參數列表:

參數	含義	用法
-p	PatternFile	指定一個Object文件(Json), 作為數據源件
-i	Input	指定一個docx文件作為模板
-o	Output	指定一個路徑，作為導出目標
-s	Source	值為json
-d	Destination	值為word, pdf
-w	WaitAtEnd	指定時，程序執行完成后，將等待用戶輸入退出
-h	Help	查看幫助

示例

.\wtt.exe -p .\sample\data.json -i .\sample\template.docx -o .\output\test.docx -s json -d word

使用DocTemplateTool.Word類庫

在項目中引用DocTemplateTool.Word

dotnet add package DocTemplateTool.Word

由于Exporter返回的NPOI對象，你需要自行根據業務來處理結果，以及處理IO異常

byte[] docFileContent;

var docinfo = GetDocInfo(); // 準備數據
var result = Exporter.ExportDocxByObject("D:\\Template.docx", docinfo); //生成NPOI文檔對象

//處理結果
using (var memoryStream = new MemoryStream())
{
    result.Write(memoryStream);
    memoryStream.Seek(0, SeekOrigin.Begin);
    docFileContent = memoryStream.ToArray();
}

//寫入文件或返回接口
File.WriteAllBytes("D:\\Result.docx", docFileContent);

占位符

占位符是指在模板中的一個標記，用于標記需要替換的文本或圖片，
文本占位符的格式為：$字段名稱[附加屬性]$
圖片占位符的格式為：#字段名稱[附加屬性]#

Exporter將掃描文檔中所有占位符，然后根據占位符的名稱，從數據源中獲取對應的文本值或圖片內容，替換到文檔中。

文本

例如

姓名：$ClientName$

將被替換為

姓名：張三

圖片

確認大小

圖片占位符支持附加屬性，用于指定圖片的寬度和高度，格式為：#字段名稱[寬度,高度]#

#Graphic[431,266]#

將被替換為一個寬度為431，高度為266的圖片，單位為像素。
若不指定寬度和高度，則使用默認圖片尺寸556*262。
在Word文檔中，因為像素大小是個相對值，頁面視圖100%時的大小為實際像素尺寸，你可以使用截圖工具或標尺工具確認圖片的大小。

設置圖片

圖片源支持本地文件和網絡圖片以及Base64編碼的圖片。

從不同圖片來源生成文檔的示例運行如下：

數據集合

由于NPOI限制，暫不支持表格的嵌套。
數據集合將以表格的形式呈現在文檔中，因此你需要在模板中預留一個表格，Exporter將根據表中單元格的占位符，填充表格各列的內容。
包含占位符的行稱之為模板行。

定義

public class HealthReportDocInfo
{
    ...
    public List<DetailList> BloodPressureList { get; set; }
}

public class DetailList
{
    public string Name { get; set; }
    public string Dept { get; set; }
    public string Value { get; set; }
    public string Result { get; set; }
}

配置模板表格：

默認以第二行作為模板行（通常第一行為表頭），你也可以根據實際情況跳過表頭，

例如在工資登記表示例中，表頭占兩行的情況下，第三行為模板行，那么你需要在配置中指定模板行的索引為2（索引從0開始）。

$Details[2]$

模板行的樣式將決定表格的樣式，因此你可以在模板行中設置表格的樣式，例如設置表格的字體，顏色，大小等。

示例運行如下圖：

其他示例

企業員工健康管理周報

心電圖報告

數據源

數據源支持從哈希表（字典）或對象中獲取數據。

Exporter提供了ExportDocxByDictionary和ExportDocxByObject兩個方法，分別用于從哈希表和對象中獲取數據。

從哈希表中獲取數據：

var docinfo = new Dictionary<string, object>()
{
    {"Dept", "XX科技股份有限公司" },
    {"Date",  DateTime.Now     },
    {"Number",  "憑 - 202301111"     },
    {"Details",  new List<Dictionary<string, object>>(){

        new Dictionary<string, object>(){
            { "Type","銷售收款"},
            { "Name","應收款"},
            { "DeptorAmount",0},
            { "LenderAmount",50000}
        },
            new Dictionary<string, object>(){
            { "Type","銷售收款"},
            { "Name","預收款"},
            { "DeptorAmount",30000},
            { "LenderAmount",0}
        },
        new Dictionary<string, object>(){
            { "Type","銷售收款"},
            { "Name","現金"},
            { "DeptorAmount",20000},
            { "LenderAmount",0}
        },

    }},
    { "DeptorSum",  50000     },
    { "LenderSum",  50000     },
    { "ClientName",  "XX科技股份有限公司"     },
    { "Teller",  "張三"     },
    { "Maker",  "李四"     },
    { "Auditor",  "王五"     },
    { "Register",  "趙六"     },
};
var result = Word.Exporter.ExportDocxByDictionary(Path.Combine(templatePath_Doc, $"AccountingTemplate.docx"), docinfo, (s) => s);

從匿名對象中獲取數據：

var docinfo = new
{

    Dept = "XX科技股份有限公司",
    Date = DateTime.Now,
    Number = "憑 - 202301111",
    Details = new List<dynamic>() {

        new
        {
            Type = "銷售收款",
            Name = "應收款",
            DeptorAmount = 0,
            LenderAmount = 50000
        },
        new
        {
            Type = "銷售收款",
            Name = "預收款",
            DeptorAmount = 30000,
            LenderAmount = 0
        },
        new
        {
            Type = "銷售收款",
            Name = "現金",
            DeptorAmount = 20000,
            LenderAmount = 0
        },
    },
    DeptorSum = 50000,
    LenderSum = 50000,
    ClientName = "XX科技股份有限公司",
    Teller = "張三",
    Maker = "李四",
    Auditor = "王五",
    Register = "趙六",
};

var result = Word.Exporter.ExportDocxByObject(Path.Combine(templatePath_Doc, $"AccountingTemplate.docx"), docinfo, (s) => s);

它們將得到同樣的結果：

已知問題

作者信息

作者：林小

郵箱：jevonsflash@qq.com

License

The MIT License (MIT)

項目地址

Github:DocTemplateTool

總結

以上是生活随笔為你收集整理的DocTemplateTool - 可根据模板生成word或pdf文件的工具的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。