Word 套版在本站是個老話題了,我最早是啟動 Word 程式用 Office Automation 處理(過程 Word 很容易當掉沒反應,不太好搞),Word 2007 docx 普及後我開始改用更可靠有效率的 OpenXML SDK,但當時只是不成熟未經實戰的構想,應讀者們敲碗多時,我還是分享了有缺陷的 PoC 版本

看看舊文日期,居然已是十年前的事。

thumbnail

近一年來因專案需求對 Word OpenXML SDK 操作有較深入了解,學到不少實務技巧,回頭看當年缺陷版遇到的難題,如今已不再令我發愁,今天這篇分享,也算技能成長的見證吧,哈!

為防有人不知道 Word 套版是什麼,還是簡單解釋一下 - Word 套版概念源自我們想用程式從資料庫或其他來源抓資料動態產生 Word 檔,實務上對輸出文件格式常有許多規格、排版要求,全部靠程式處理包你寫到流淚,更別提每次改一個字調個顏色就要改程式多讓人崩潰。

因此,套版是較有效率的方法。請使用者自己先用 Word 依規格、喜好做出範本檔,需要動態放入文字的地方再以 [$ParserTag$] 之類的符號註記,如以下的例子:

接著我們用一小段程式便能將動態內容套入範本產生文件:

        static void Example01_WordTmplRendering()
        {
            var docxBytes = WordRender.GenerateDocx(File.ReadAllBytes("AnnounceTemplate.docx"), 
                new Dictionary<string, string>()
                {
                ["Title"] = "澄清黑暗執行緒部落格併購傳聞",
                ["SeqNo"] = "2021-FAKE-001",
                ["PubDate"] = "2021-04-01",
                ["Source"] = "亞太地區公關部",
                ["Content"] = @"
  坊間媒體盛傳「史塔克工業將以美金 18 億元併購黑暗執行緒部落格」一事,
本站在此澄清並無此事。\n\n
  史塔克公司執行長日前確實曾派遣代表來訪,雙方就技術合作一事交換意見,
相談甚歡,惟本站暫無出售計劃,且傳聞金額亦不符合本站預估價值(謎之聲:180 元都嫌貴),
純屬不實資訊。\n\n  
  本站將秉持初衷,持續發揚野人獻曝、敝帚自珍精神,歡迎舊雨新知繼續支持。"
                });
            File.WriteAllBytes(
                Path.Combine(ResultFolder, $"套表測試-{DateTime.Now:HHmmss}.docx"),
                docxBytes);
        }

之後若文件排版或固定文字需要修改,請使用者提供修改過的範本檔更新即可,程式完全不用動,是不是很美妙?

十年前 PoC 版本有個問題 - 由於它並不解析 OpenXML 元素,而是直接將 XML 中的 [$ParserTag$] 換成對映文字,但實務上你看到的 [$ParserTag$] 在 XML 中幾乎不會連在一起,多半長成這樣:

要克服這個問題倒也不難,解析 OpenXML Word 文件的 Paragraph / Run / Text 結構,逐一比對相鄰 Run 的文字內容一定可還原出 [$ParserTag$] 文字內容,再進行置換即可。而這裡有個技巧,為提升在茫茫元素大海找出目標的效率並減少誤判,我會請使用者在製作範本檔時為 [$ParserTag$] 加上「醒目提示」(如下圖)。 醒目提示的顏色不限,可配合當下文字顏色,反正它們在產生文件時會被移除:

另外針對長段文字需強制換行的需求,我增加了一個「將字串內容 "\n" (反斜線加 n 兩個字元) 轉成強制換行」(相當 Word 按 Shift-Enter 的效果)的規格。

核心程式不到 80 行,實測了一陣子目前沒遇到什麼問題,就提供有需要的同學們參考吧!

using DocumentFormat.OpenXml;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;

namespace Examples
{
    public static class WordRender
    {
        static void ReplaceParserTag(this OpenXmlElement elem, Dictionary<string, string> data)
        {
            var pool = new List<Run>();
            var matchText = string.Empty;
            var hiliteRuns = elem.Descendants<Run>() //找出鮮明提示
                .Where(o => o.RunProperties?.Elements<Highlight>().Any() ?? false).ToList();

            foreach (var run in hiliteRuns)
            {
                var t = run.InnerText;
                if (t.StartsWith("["))
                {
                    pool = new List<Run> { run };
                    matchText = t;
                }
                else
                {
                    matchText += t;
                    pool.Add(run);
                }
                if (t.EndsWith("]"))
                {
                    var m = Regex.Match(matchText, @"\[\$(?<n>\w+)\$\]");
                    if (m.Success && data.ContainsKey(m.Groups["n"].Value))
                    {
                        var firstRun = pool.First();
                        firstRun.RemoveAllChildren<Text>();
                        firstRun.RunProperties.RemoveAllChildren<Highlight>();
                        var newText = data[m.Groups["n"].Value];
                        var firstLine = true;
                        foreach (var line in Regex.Split(newText, @"\\n"))
                        {
                            if (firstLine) firstLine = false;
                            else firstRun.Append(new Break());
                            firstRun.Append(new Text(line));
                        }
                        pool.Skip(1).ToList().ForEach(o => o.Remove());
                    }
                }
                
            }
        }

        public static byte[] GenerateDocx(byte[] template, Dictionary<string, string> data)
        {
            using (var ms = new MemoryStream())
            {
                ms.Write(template, 0, template.Length);
                using (var docx = WordprocessingDocument.Open(ms, true))
                {
                    docx.MainDocumentPart.HeaderParts.ToList().ForEach(hdr =>
                    {
                        hdr.Header.ReplaceParserTag(data);
                    });
                    docx.MainDocumentPart.FooterParts.ToList().ForEach(ftr =>
                    {
                        ftr.Footer.ReplaceParserTag(data);
                    });
                    docx.MainDocumentPart.Document.Body.ReplaceParserTag(data);
                    docx.Save();
                }
                return ms.ToArray();
            }
        }
    }
}

A simple example to rendering Word document from template docx with OpenXML SDK.


Comments

# by Albert

這個好用。趕快收起來。謝謝黑大的分享!!

# by ByTIM

公告日期:四月一日 (誤...我搞錯重點了!

# by Spider

請問黑大, 如果是列表形式的報表, 也能這樣套嗎? 一直在找Crystal Report的替代方案, 謝謝!

# by Jeffrey

to Spider,產生表格功能我也完成 PoC 了,過陣子會分享。

# by Spider

黑大, 非常感激!

# by

不知哪裡有誤~~~ using DocumentFormat.OpenXml; using DocumentFormat.OpenXml.Drawing; using DocumentFormat.OpenXml.Packaging; using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text.RegularExpressions; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; namespace word { public partial class index : System.Web.UI.Page { protected void Page_Load(object sender, EventArgs e) { } protected void Unnamed1_Click(object sender, EventArgs e) { // string path = @"Document/123.docx"; string path = Server.MapPath("Document/123.docx"); // 路徑 var docxBytes = Examples.WordRender.GenerateDocx(File.ReadAllBytes(path), new Dictionary<string, string>() { ["abc"] = "澄清黑暗執行緒部落格併購傳聞", ["gg"]="333", ["hh"] = "333" }); string PathS = Server.MapPath("Document"); // 路徑 File.WriteAllBytes( System.IO.Path.Combine(PathS, $"套表測試-{DateTime.Now:HHmmss}.docx"), docxBytes); } } namespace Examples { public static class WordRender { static void ReplaceParserTag(this OpenXmlElement elem, Dictionary<string, string> data) { var pool = new List<Run>(); var matchText = string.Empty; var hiliteRuns = elem.Descendants<Run>() //找出鮮明提示 .Where(o => o.RunProperties?.Elements<Highlight>().Any() ?? false).ToList(); foreach (var run in hiliteRuns) { var t = run.InnerText; if (t.StartsWith("[")) { pool = new List<Run> { run }; matchText = t; } else { matchText += t; pool.Add(run); } if (t.EndsWith("]")) { var m = Regex.Match(matchText, @"\[\$(?<n>\w+)\$\]"); if (m.Success && data.ContainsKey(m.Groups["n"].Value)) { var firstRun = pool.First(); firstRun.RemoveAllChildren<Text>(); firstRun.RunProperties.RemoveAllChildren<Highlight>(); var newText = data[m.Groups["n"].Value]; var firstLine = true; foreach (var line in Regex.Split(newText, @"\\n")) { if (firstLine) firstLine = false; else firstRun.Append(new Break()); firstRun.Append(new Text(line)); } pool.Skip(1).ToList().ForEach(o => o.Remove()); } } } } public static byte[] GenerateDocx(byte[] template, Dictionary<string, string> data) { using (var ms = new MemoryStream()) { ms.Write(template, 0, template.Length); using (var docx = WordprocessingDocument.Open(ms, true)) { docx.MainDocumentPart.HeaderParts.ToList().ForEach(hdr => { hdr.Header.ReplaceParserTag(data); }); docx.MainDocumentPart.FooterParts.ToList().ForEach(ftr => { ftr.Footer.ReplaceParserTag(data); }); docx.MainDocumentPart.Document.Body.ReplaceParserTag(data); docx.Save(); } return ms.ToArray(); } } } } }

# by Jeffrey

to 彰,能把有問題的專案放上 Github 方便大家重現問題幫忙抓蟲嗎?

Post a comment


81 - 49 =