簡(jiǎn)介面向需要在C#程序中自動(dòng)化生成Word報(bào)表的.NET開(kāi)發(fā)者這份PDF演示了如何借助OpenXml SDK為Word文檔添加表格。內(nèi)容從引入DocumentFormat.OpenXml命名空間開(kāi)始逐步講解AddTable方法的封裝、TableGrid列數(shù)定義、表格邊框樣式設(shè)置以及表頭和數(shù)據(jù)行的循環(huán)創(chuàng)建邏輯并配有可直接運(yùn)行的示例代碼和運(yùn)行效果便于遷移到批量生成、數(shù)據(jù)導(dǎo)出等實(shí)際場(chǎng)景。資源共1個(gè)PDF文件大小121KB目前已有326人學(xué)習(xí)下載適合具備基礎(chǔ)C#語(yǔ)法、希望以輕量方式操作Word文檔的讀者快速查閱。1. C# 用 OpenXml 給 Word 加表格為什么我不再碰 COM 自動(dòng)化實(shí)際做報(bào)表導(dǎo)出的人多半經(jīng)歷過(guò)這種場(chǎng)景程序需要往 Word 文檔里插入一張表格數(shù)據(jù)量不大但要求格式規(guī)整、邊框齊全。常見(jiàn)做法是直接調(diào) COM 自動(dòng)化控制 Word 進(jìn)程開(kāi)發(fā)機(jī)上跑得很好一旦部署到?jīng)]裝 Office 的服務(wù)器上就各種罷工。換成開(kāi)源的 OpenXml SDK 后直接操作 docx 底層的 XML 結(jié)構(gòu)不依賴 Office批量生成帶表格的 Word 文檔變得干凈可控。這篇文章圍繞一個(gè)具體需求展開(kāi)用 C# 的 OpenXml 給 Word 文檔添加表格覆蓋表頭、數(shù)據(jù)行、邊框、單元格樣式和最常見(jiàn)的坑。適合用 .NET 做報(bào)告生成、合同填充、批量導(dǎo)出功能的開(kāi)發(fā)者尤其是需要在 Windows 服務(wù)里跑批處理的場(chǎng)景。2. 先摸清 Word 表格的 XML 骨架再寫(xiě)第一段可運(yùn)行代碼在寫(xiě)第一行代碼之前建議花十分鐘把 OpenXml 的 Word 文檔模型過(guò)一遍。很多人直接抄一份代碼就改結(jié)果要么列寬失效要么表格插不進(jìn)正文最后繞回來(lái)補(bǔ)基礎(chǔ)反而更慢。這一章的思路是從打開(kāi)文檔的方式講起再看 Table 的層級(jí)最后給出一段能直接跑通的最小代碼。2.1 WordprocessingDocument 打開(kāi)文檔的三種方式別只會(huì) Open(path, true)OpenXml SDK 的操作入口是WordprocessingDocument它指向的是一個(gè) .docx 包很多人把它當(dāng)普通文件流用結(jié)果在生命周期管理上翻車。最常見(jiàn)的打開(kāi)方式有三個(gè)。第一種打開(kāi)已經(jīng)存在的文檔并允許修改using (WordprocessingDocument doc WordprocessingDocument.Open(Test.docx, true)) { // 這里可以增刪改 }第二個(gè)參數(shù)isEditable必須傳 true如果只傳路徑不傳這個(gè)參數(shù)默認(rèn)是只讀。只讀模式不會(huì)立刻報(bào)錯(cuò)但之后的Append、Add操作都會(huì)靜默失敗保存后一切變動(dòng)都丟了。這是新手最容易迷惑的地方不報(bào)錯(cuò)卻等于白寫(xiě)。第二種新建一個(gè)空白文檔。Open方法要求文件真實(shí)存在否則拋FileNotFoundException。正確做法是用Createusing (WordprocessingDocument doc WordprocessingDocument.Create(NewDoc.docx, WordprocessingDocumentType.Document)) { MainDocumentPart mainPart doc.AddMainDocumentPart(); mainPart.Document new Document(new Body()); }這段代碼有兩個(gè)點(diǎn)不能省AddMainDocumentPart()負(fù)責(zé)創(chuàng)建文檔主部件Document new Document(new Body())負(fù)責(zé)在包內(nèi)生成空的正文結(jié)構(gòu)。少一句后面訪問(wèn)doc.MainDocumentPart.Document.Body就會(huì)得到 null 引用。第三種從流打開(kāi)。常用于把模板讀進(jìn)MemoryStream再傳給Open(stream, true)避免臨時(shí)文件落盤。這時(shí)要注意流的所有權(quán)doc.Dispose()時(shí)也會(huì)關(guān)閉流后續(xù)如果還要用這個(gè)流得自己重新創(chuàng)建。批處理時(shí)如果同時(shí)操作多個(gè)文件用流方式可以避免很多文件句柄問(wèn)題。using是這個(gè)場(chǎng)景的硬性要求。OpenXml 包在Dispose時(shí)才把未保存的內(nèi)容寫(xiě)回文件如果不Dispose要么文件一直被占用要么改動(dòng)直接丟失。我見(jiàn)過(guò)不止一個(gè)人因?yàn)樯賹?xiě)using排查到半夜最后發(fā)現(xiàn)是 Word 進(jìn)程把 docx 鎖住了。2.2 Table 的層級(jí)Table、TableGrid、TableRow、TableCell、ParagraphWord 表格在 OpenXml 里的結(jié)構(gòu)不是簡(jiǎn)單的二維數(shù)組而是一個(gè)嵌套樹(shù)。一個(gè)正常的表格從上到下大致是這個(gè)形狀Table ├── TableGrid │ └── TableGridColumn ├── TableProperties ├── TableRow │ └── TableCell │ └── Paragraph │ └── Run │ └── TextTableGrid定義表格一共有多少列以及每列的寬度。TableGridColumn的Width屬性單位是 twips1 厘米約等于 567 twips做導(dǎo)出的同學(xué)按這個(gè)比例換就行。TableRow是行TableCell是單元格單元格不能直接放字符串必須先有Paragraph再在Paragraph里放Run最后在Run里放Text。這個(gè)嵌套順序是 Word 渲染的基本要求缺一層都會(huì)導(dǎo)致文檔結(jié)構(gòu)不完整。理解了層級(jí)再回頭看原示例代碼里的grid.Append(new TableGrid())就能發(fā)現(xiàn)問(wèn)題應(yīng)該追加的是TableGridColumn而不是又一個(gè)TableGrid同時(shí)grid也需要由table.Append(grid)掛到 Table 上。原示例里 grid 創(chuàng)建之后沒(méi)有真正進(jìn)入 Table列定義等于無(wú)效。這種問(wèn)題 SDK 不會(huì)報(bào)錯(cuò)但 Word 打開(kāi)時(shí)列寬會(huì)全部按照內(nèi)容自動(dòng)分配。這里還要糾正一個(gè)隱藏得更深的錯(cuò)誤原示例在插入表格時(shí)用了new Paragraph(new Run(table))。Table是不能被塞進(jìn)Run里的它必須直接作為 Body 或容器的子元素。這種寫(xiě)法的本意可能是想給表格包一層段落但 OpenXml 沒(méi)有這種構(gòu)造方式。正確做法是直接body.Append(table)表格本身已經(jīng)是一個(gè)獨(dú)立的塊級(jí)元素。2.3 最小可運(yùn)行示例從空白文檔到三列表格把前面幾個(gè)要素串起來(lái)最小可運(yùn)行代碼是下面這樣using System; using DocumentFormat.OpenXml; using DocumentFormat.OpenXml.Packaging; using DocumentFormat.OpenXml.Wordprocessing; public static void CreateSimpleTable(string filePath) { using (WordprocessingDocument doc WordprocessingDocument.Create(filePath, WordprocessingDocumentType.Document)) { MainDocumentPart mainPart doc.AddMainDocumentPart(); mainPart.Document new Document(new Body()); Table table new Table(); // 1. 定義兩列每列寬度 2000 twips TableGrid grid new TableGrid(); grid.Append(new TableGridColumn() { Width 2000 }); grid.Append(new TableGridColumn() { Width 2000 }); table.Append(grid); // 2. 第一行兩個(gè)單元格 TableRow row new TableRow(); row.Append(CreateCell(A)); row.Append(CreateCell(B)); table.Append(row); mainPart.Document.Body.Append(table); } } private static TableCell CreateCell(string text) { TableCell cell new TableCell(); Paragraph paragraph new Paragraph(); Run run new Run(); run.Append(new Text(text)); paragraph.Append(run); cell.Append(paragraph); return cell; }這段代碼的邏輯很直接先創(chuàng)建Table把TableGrid掛進(jìn)去定義列寬然后一行行構(gòu)建單元格最后把表格掛到Body末尾。CreateCell方法值得說(shuō)明一下TableCell下面必須有一個(gè)段落段落里必須有 RunRun 里才是文本這個(gè)嵌套在業(yè)務(wù)代碼里很容易漏寫(xiě)漏了之后 Word 里會(huì)顯示成空單元格。參數(shù)說(shuō)明TableGridColumn.Width傳的是 twips 字符串想按內(nèi)容自適應(yīng)可以傳auto但報(bào)表場(chǎng)景我更推薦固定值因?yàn)?Word 在無(wú)表格列定義或列寬不一致時(shí)會(huì)按照內(nèi)容長(zhǎng)度自行分配導(dǎo)致最終效果和設(shè)計(jì)稿差很多。兩列的Width 2000就是大約 3.5 厘米按需調(diào)整。這個(gè)例子跑通后你已經(jīng)有了一個(gè)結(jié)構(gòu)合法的表格。接下來(lái)要做的是把表頭和數(shù)據(jù)行真正填進(jìn)去并加上邊框。3. 把表頭和業(yè)務(wù)數(shù)據(jù)寫(xiě)進(jìn) WordAddTable 方法的完整拆解項(xiàng)目示例的 AddTable 方法本質(zhì)上是在解決三件事數(shù)據(jù)怎么傳進(jìn)來(lái)、每一行怎么創(chuàng)建、表格邊框怎么不丟。這一章把它拆開(kāi)講順帶修正示例里幾個(gè)測(cè)試時(shí)發(fā)現(xiàn)的問(wèn)題。3.1 方法簽名與數(shù)據(jù)準(zhǔn)備為什么用 Liststring[]AddTable的典型簽名是public static void AddTable(string wordPath, Liststring[] lstData, string[] headerArray)三個(gè)參數(shù)分別是 Word 文件路徑、二維數(shù)據(jù)每一行是 string[]、表頭數(shù)組。用Liststring[]看著不夠面向?qū)ο蟮谂繉?dǎo)出場(chǎng)景非常實(shí)用數(shù)據(jù)從數(shù)據(jù)庫(kù)查出來(lái)后通常也是 List 結(jié)構(gòu)直接 select 成 string[] 即可省去為每個(gè)報(bào)表單獨(dú)建實(shí)體類的步驟。OpenXml 只關(guān)心字符串內(nèi)容格式化交給上層處理。這里要留意一個(gè)細(xì)節(jié)列數(shù)。示例里用lstData.Select(x x.Count()).Max()求最大列數(shù)思路對(duì)但有個(gè)隱患。如果某一行數(shù)組長(zhǎng)度小于最大列數(shù)后面遍歷建行時(shí)該行會(huì)少幾個(gè)單元格Word 里會(huì)表現(xiàn)出單元格錯(cuò)位或表格列數(shù)不一致。我一般在構(gòu)建表格前統(tǒng)一補(bǔ)成等長(zhǎng)數(shù)組int maxColumnNum lstData.Max(x x.Length); for (int i 0; i lstData.Count; i) { if (lstData[i].Length maxColumnNum) continue; string[] paddedRow new string[maxColumnNum]; Array.Copy(lstData[i], paddedRow, lstData[i].Length); for (int j lstData[i].Length; j maxColumnNum; j) paddedRow[j] string.Empty; lstData[i] paddedRow; }這段代碼的邏輯是先算出最大列數(shù)然后把每一行長(zhǎng)度不足的部分用空字符串補(bǔ)齊。補(bǔ)位之后整個(gè)二維數(shù)組變成一個(gè)規(guī)整的矩形TableRow 數(shù)量穩(wěn)定TableGrid 的列定義才不會(huì)失效。如果你的數(shù)據(jù)本來(lái)就規(guī)整這段可以不寫(xiě)但報(bào)表數(shù)據(jù)來(lái)自多張表時(shí)字段缺失是常態(tài)留著更安全。3.2 TableRow 統(tǒng)一構(gòu)建表頭和內(nèi)容用同一個(gè)方法原示例把表頭和數(shù)據(jù)行用同一個(gè) foreach 邏輯處理這個(gè)思路很好。我傾向于再抽一個(gè)BuildRow方法表頭和數(shù)據(jù)都通過(guò)它來(lái)創(chuàng)建行后面要單獨(dú)改樣式時(shí)只動(dòng)表頭那一次調(diào)用即可。private static TableRow BuildRow(IEnumerablestring cellTexts) { TableRow row new TableRow(); foreach (string text in cellTexts) { TableCell cell new TableCell(); Paragraph paragraph new Paragraph(); Run run new Run(); run.Append(new Text(text)); paragraph.Append(run); cell.Append(paragraph); row.Append(cell); } return row; }這個(gè)方法內(nèi)部做的事情非常直白每個(gè)字符串都創(chuàng)建一個(gè)單元格單元格里放一個(gè)段落段落里放一個(gè) RunRun 里才是文本。很多初學(xué)者會(huì)把 Text 直接塞給 TableCell這是行不通的。TableCell 在 OpenXml 里只是容器不經(jīng)過(guò) Paragraph 和 Run 兩層包裝Word 根本不會(huì)把內(nèi)容當(dāng)作可顯示文本。參數(shù)說(shuō)明IEnumerablestring讓方法同時(shí)接收數(shù)組和 List表頭數(shù)組可以傳數(shù)據(jù)行 string[] 也可以傳。如果你想在表頭行加粗、加底色可以把表頭作為單獨(dú)字段放進(jìn)去或者在生成表頭后用另一個(gè)賦值函數(shù)處理第一行對(duì)象。后面 4.1 會(huì)給一個(gè)帶樣式的表頭單元格寫(xiě)法。示例還提到“有 TableHeader 對(duì)象用不來(lái)”。解釋一下TableHeader是TableRow的派生類專門用于跨頁(yè)重復(fù)表頭。如果表格不會(huì)跨頁(yè)用普通 TableRow 就行如果表格長(zhǎng)到跨頁(yè)希望每一頁(yè)頂部都出現(xiàn)表頭第一行應(yīng)該用TableHeader。這一點(diǎn)到 4.4 再展開(kāi)。3.3 TableProperties 邊框配置六個(gè)方向的邊框一個(gè)都不能少默認(rèn)情況下OpenXml 創(chuàng)建的表格不帶邊框直接寫(xiě)入 Word 會(huì)顯示成無(wú)框線表格。要加邊框必須給 Table 掛TableProperties里面再放TableBorders。示例里的邊框?qū)懛ū旧硎菍?duì)的但有幾個(gè)參數(shù)值得展開(kāi)TableProperties tblProp new TableProperties( new TableBorders( new TopBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 2 }, new BottomBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 2 }, new LeftBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 2 }, new RightBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 2 }, new InsideHorizontalBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 2 }, new InsideVerticalBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 2 })); table.Append(tblProp);邊框類型有六種上、下、左、右、內(nèi)部橫線、內(nèi)部豎線。Size的單位不是像素而是 1/8 磅Size 2實(shí)際約等于 0.25 磅屏幕上看著像沒(méi)有。想要明顯一點(diǎn)的邊框給 4 或 8分別對(duì)應(yīng) 0.5 磅和 1 磅。Val除了Single還有Dashed、Dotted、Double但正式報(bào)表用 Single 最穩(wěn)妥。另一個(gè)關(guān)鍵是枚舉的寫(xiě)法。OpenXml SDK 里大多數(shù)屬性值是強(qiáng)類型枚舉比如BorderValues.Single賦值時(shí)要通過(guò)new EnumValueBorderValues(...)包一層不能直接寫(xiě) BorderValues.Single。很多從舊版 OpenXml 2.0 遷移過(guò)來(lái)的同學(xué)經(jīng)常在這里遇到編譯錯(cuò)誤。TableProperties里子元素的順序也有講究。Word 對(duì)tblPr內(nèi)部元素有固定 schema 順序手動(dòng)Append時(shí)容易打亂。順序不對(duì)SDK 不會(huì)報(bào)錯(cuò)但 Word 打開(kāi)可能忽略部分屬性。穩(wěn)妥做法是用構(gòu)造函數(shù)一次傳完不要多次 Append。3.4 更完整的 AddTable 流程整合數(shù)據(jù)、表頭、邊框把以上內(nèi)容組合起來(lái)一個(gè)能用于生產(chǎn)環(huán)境的 AddTable 大致如下public static void AddTable(string wordPath, Liststring[] lstData, string[] headerArray) { using (WordprocessingDocument doc WordprocessingDocument.Open(wordPath, true)) { Body body doc.MainDocumentPart.Document.Body; int maxColumnNum Math.Max(headerArray.Length, lstData.Max(x x.Length)); Table table new Table(); // 列定義 TableGrid grid new TableGrid(); for (int i 0; i maxColumnNum; i) { grid.Append(new TableGridColumn() { Width 2500 }); } table.Append(grid); // 邊框?qū)傩?TableProperties tblProp new TableProperties( new TableBorders( new TopBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 }, new BottomBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 }, new LeftBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 }, new RightBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 }, new InsideHorizontalBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 }, new InsideVerticalBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 })); table.Append(tblProp); // 表頭行 table.Append(BuildRow(headerArray)); // 數(shù)據(jù)行 foreach (string[] rowData in lstData) { table.Append(BuildRow(rowData)); } body.Append(table); } }這段代碼和原示例主干一致但做了三處修正第一grid 里追加的是TableGridColumn并且真正掛到 table 上第二邊框 Size 提高到了 4更適合查看和打印第三表頭和數(shù)據(jù)的行構(gòu)建統(tǒng)一走BuildRow避免重復(fù)代碼。有同學(xué)問(wèn)為什么 TableGrid 要放在 TableProperties 前面。實(shí)際上 Table 內(nèi)元素按照 OOXML 的 schemaTableGrid 應(yīng)該出現(xiàn)在 TableRow 之前TableProperties 一般放在 TableGrid 之后。具體順序可以用 OpenXmlValidator 驗(yàn)證這個(gè)驗(yàn)證器在最后一章會(huì)給代碼。順序正確的前提下Word 才能穩(wěn)定地識(shí)別邊框和列寬。4. 單元格樣式與通用布局背景色、對(duì)齊、合并、重復(fù)表頭基礎(chǔ)表格能跑通后真實(shí)的報(bào)表需求就來(lái)了表頭要加底色、數(shù)字列要右對(duì)齊、某些單元格要合并。這一章把單元格樣式和高頻布局操作拆開(kāi)代碼都是可以直接抄進(jìn)項(xiàng)目的。4.1 TableCellProperties 與 Shading給表頭加上底色單元格樣式最核心的對(duì)象是TableCellProperties簡(jiǎn)稱 tcPr。它負(fù)責(zé)單元格寬度、背景色、垂直對(duì)齊、合并等。給表頭加底色要往 tcPr 里塞Shadingprivate static TableCell BuildHeaderCell(string text) { TableCell cell new TableCell(); TableCellProperties cellProps new TableCellProperties(); // 背景色Fill 是十六進(jìn)制不帶 # Shading shading new Shading() { Fill D9E2F3 }; cellProps.Append(shading); // 單元格寬度單位 twips TableCellWidth cellWidth new TableCellWidth() { Type TableWidthUnitValues.Dxa, Width 2500 }; cellProps.Append(cellWidth); cell.Append(cellProps); Paragraph paragraph new Paragraph(); // 段落居中 ParagraphProperties paraProps new ParagraphProperties(); paraProps.Append(new Justification() { Val JustificationValues.Center }); paragraph.Append(paraProps); Run run new Run(); run.Append(new Text(text)); paragraph.Append(run); cell.Append(paragraph); return cell; }Fill是十六進(jìn)制顏色字符串不帶 # 號(hào)。D9E2F3是淺藍(lán)灰表頭常用。TableCellWidth的Type有三種Dxa固定寬度、Auto自動(dòng)、Pct百分比。建議固定列寬都用Dxa讓 Word 不參與列寬決策。Justification控制段落文字在單元格內(nèi)的水平對(duì)齊Center居中Right右對(duì)齊。如果還要控制垂直居中需要在 tcPr 上追加TableCellVerticalAlignmentcellProps.Append(new TableCellVerticalAlignment() { Val TableVerticalAlignmentValues.Center });有個(gè)坑必須提醒TableCellProperties在TableCell里必須位于Paragraph之前。如果先 Append 了 Paragraph 再 Append tcPr文檔結(jié)構(gòu)不符合 schema有些 Word 版本會(huì)直接視為無(wú)效單元格。SDK 平時(shí)不攔你但驗(yàn)證階段會(huì)報(bào)警。4.2 合并單元格GridSpan 做水平合并VerticalMerge 做垂直合并合并單元格在制作復(fù)雜表頭時(shí)躲不開(kāi)。OpenXml 里水平合并和垂直合并不是一回事。水平合并用GridSpan表示這個(gè)單元格橫跨幾列。比如一個(gè)單元格跨兩列TableCell spanCell new TableCell(); TableCellProperties spanProps new TableCellProperties(); spanProps.Append(new GridSpan() { Val 2 }); spanCell.Append(spanProps); Paragraph p new Paragraph(); p.Append(new Run(new Text(跨兩列))); spanCell.Append(p);使用GridSpan時(shí)TableGrid 里依然定義兩列但該行里的單元格數(shù)量會(huì)少一個(gè)。這不會(huì)導(dǎo)致列數(shù)錯(cuò)誤因?yàn)?Word 知道這個(gè)單元格占了兩列的位置。垂直合并用VerticalMerge和 Excel 的合并單元格概念不同。需要兩個(gè)單元格配合起始單元格設(shè)置Restart后續(xù)單元格設(shè)置Continue。比如// 第一行 TableCell vMergeStart new TableCell(); vMergeStart.Append(new TableCellProperties( new VerticalMerge() { Val MergedCellValues.Restart })); vMergeStart.Append(new Paragraph(new Run(new Text(縱向合并)))); // 第二行 TableCell vMergeContinue new TableCell(); vMergeContinue.Append(new TableCellProperties( new VerticalMerge() { Val MergedCellValues.Continue })); vMergeContinue.Append(new Paragraph());Continue單元格不需要寫(xiě)文本W(wǎng)ord 會(huì)把它并入上方的起始單元格。但最好保留一個(gè)空 Paragraph否則個(gè)別版本在打印預(yù)覽時(shí)會(huì)出現(xiàn)高度不對(duì)的問(wèn)題。我在一次打印測(cè)試?yán)锞鸵?jiàn)過(guò)表格第二頁(yè)多出一條空白橫線原因就是 Continue 單元格里沒(méi)有 Paragraph。4.3 表格整體寬度和對(duì)齊TableWidth 與 TableJustification除了單元格整個(gè)表格也能設(shè)置寬度和頁(yè)面水平對(duì)齊。比如讓表格居中并占滿頁(yè)面寬度可以這樣寫(xiě)TableProperties tableProps new TableProperties( new TableWidth() { Type TableWidthUnitValues.Pct, Width 5000 }, new TableJustification() { Val TableRowAlignmentValues.Center }); table.Append(tableProps);這里的5000在 Pct 類型下代表 100%因?yàn)?Word 內(nèi)部把百分比放大了。如果你要 50% 寬度寫(xiě)2500如果不想換算直接用Dxa類型比如Width 8500大約是一頁(yè) A4 可用寬度。這個(gè)換算關(guān)系很容易錯(cuò)很多項(xiàng)目的表格寬度異常都是在這里翻車的。TableJustification控制的是表格在頁(yè)面上的左右位置和單元格內(nèi)文字對(duì)齊是兩回事。我做報(bào)表的習(xí)慣是外層表格居中單元格內(nèi)文字按列性質(zhì)決定居左還是居右數(shù)字列右對(duì)齊文本列左對(duì)齊這個(gè)組合最常見(jiàn)。4.4 讓表頭跨頁(yè)重復(fù)TableHeader 的正確打開(kāi)方式長(zhǎng)表格跨頁(yè)后第二頁(yè)頂部往往沒(méi)有表頭閱讀體驗(yàn)很差。OpenXml 提供了TableHeader它繼承自TableRow只需要把第一行替換成它TableHeader headerRow new TableHeader(); foreach (string headerText in headerArray) { headerRow.Append(BuildHeaderCell(headerText)); } table.InsertAt(headerRow, 0);使用限制有兩點(diǎn)表頭必須是表格的第一行表格真正跨頁(yè)時(shí)才有效。如果表格只有幾行TableHeader和普通TableRow沒(méi)有區(qū)別。項(xiàng)目中遇到一頁(yè)裝不下的明細(xì)表加上這個(gè)設(shè)置第二頁(yè)頂部會(huì)自動(dòng)出現(xiàn)重復(fù)表頭省去手工分頁(yè)的煩惱。5. 用 OpenXml 加表格避坑記錄五個(gè)翻車現(xiàn)場(chǎng)與修復(fù)這一章記錄的是實(shí)際開(kāi)發(fā)中容易反復(fù)踩的五個(gè)問(wèn)題。每條按“現(xiàn)象、原因、解決”的順序?qū)懛奖隳銓?duì)照自己的代碼。5.1 表格列寬失效grid 沒(méi)掛到 Table 上Width 全白設(shè)現(xiàn)象表格成功寫(xiě)入 Word但列寬完全不受控制有的列被內(nèi)容撐得很寬有的擠成一團(tuán)檢查代碼TableGridColumn的 Width 都寫(xiě)了就是無(wú)效。原因大多是結(jié)構(gòu)錯(cuò)誤。常見(jiàn)兩種一是把new TableGridColumn()寫(xiě)成了new TableGrid()導(dǎo)致 grid 里沒(méi)有列定義二是創(chuàng)建了 grid 卻忘了table.Append(grid)導(dǎo)致 TableGrid 沒(méi)有成為 Table 子元素。Word 找不到列定義時(shí)只能按單元格內(nèi)容自動(dòng)分配列寬。解決嚴(yán)格按層級(jí)把 grid 放進(jìn) tableTableGrid grid new TableGrid(); for (int i 0; i columnCount; i) { grid.Append(new TableGridColumn() { Width 2500 }); } table.Append(grid);如果修正后列寬仍不對(duì)檢查 TableGridColumn 的數(shù)量和數(shù)據(jù)行里 TableCell 的數(shù)量是否一致。比如一行有 3 個(gè)單元格grid 卻定義 4 列Word 表格會(huì)多出一列默認(rèn)寬度。遇到這種情況用 OpenXmlValidator 會(huì)提示列數(shù)與網(wǎng)格不匹配。5.2 直接 Open 不存在的文件FileNotFoundException 而不是友好提示現(xiàn)象程序在WordprocessingDocument.Open(不存在的.docx, true)這一行拋出FileNotFoundException路徑?jīng)]問(wèn)題但文件確實(shí)不在。原因Open方法不支持“文件不存在就自動(dòng)創(chuàng)建”。它要求目標(biāo)文件已經(jīng)存在且是合法 .docx。原示例默認(rèn)Test.docx已經(jīng)存在許多初學(xué)者把路徑換成自己的沒(méi)注意文件根本不存在于是直接失敗。解決在打開(kāi)前做一次存在性判斷不存在就用Create建一個(gè)空白文檔if (!File.Exists(wordPath)) { using (WordprocessingDocument doc WordprocessingDocument.Create(wordPath, WordprocessingDocumentType.Document)) { MainDocumentPart mainPart doc.AddMainDocumentPart(); mainPart.Document new Document(new Body()); } }如果擔(dān)心 Create 會(huì)覆蓋可以把判斷邏輯放在程序入口生成文件名的同時(shí)確認(rèn)文件狀態(tài)。批量導(dǎo)出時(shí)我一般是先刪掉舊的臨時(shí)文件再 Create避免殘留數(shù)據(jù)。5.3 docx 文件被占用IOException 或“文件正由另一進(jìn)程使用”現(xiàn)象第一次運(yùn)行正常第二次運(yùn)行時(shí)報(bào)IOException提示文件正由另一進(jìn)程使用。或者寫(xiě)入過(guò)程中Word 打開(kāi)了同一個(gè)文件保存直接失敗。原因docx 本質(zhì)是 ZIP 包WordprocessingDocument.Open會(huì)持有底層文件句柄直到對(duì)象釋放。如果using沒(méi)寫(xiě)句柄不會(huì)釋放另一種情況是自己創(chuàng)建的 FileStream 也占用著文件和 OpenXml 包的句柄沖突。Word 打開(kāi)同一個(gè)文件時(shí)同樣不允許其他進(jìn)程覆蓋寫(xiě)入。解決第一所有入口都用using包裹。第二不要在外部額外打開(kāi) FileStream。第三服務(wù)器批處理場(chǎng)景下先復(fù)制一份到臨時(shí)路徑再操作string tmpPath Path.GetTempFileName(); File.Copy(wordPath, tmpPath, true); using (WordprocessingDocument doc WordprocessingDocument.Open(tmpPath, true)) { // 寫(xiě)入表格 doc.SaveAs(wordPath); } File.Delete(tmpPath);這樣源文件始終不被占用寫(xiě)入完成后用SaveAs覆蓋回去。注意SaveAs只能在 Open 模式下使用Create 模式下不支持這個(gè)細(xì)節(jié)也值得記住。5.4 中文亂碼或文字不顯示很多情況下是少了一層 RunProperties現(xiàn)象表格寫(xiě)入成功但中文在 Word 里顯示成問(wèn)號(hào)、方塊或者單元格里空白一片點(diǎn)擊進(jìn)入才能看到文字。代碼里明明用new Text(中文)寫(xiě)入的。原因OpenXml 寫(xiě)文本時(shí)如果 Run 沒(méi)有指定字體Word 會(huì)用文檔默認(rèn)字體。沒(méi)有 Office 的服務(wù)器環(huán)境里默認(rèn)字體可能不是中文字體于是在渲染階段變成亂碼。另外如果單元格里只有 Text 沒(méi)有 Paragraph或者 Run 沒(méi)有掛進(jìn) ParagraphWord 也識(shí)別不到內(nèi)容。解決給 Run 顯式設(shè)置中文字體覆蓋三個(gè)字體槽RunProperties runProps new RunProperties(); runProps.Append(new Fonts() { Ascii Microsoft YaHei, HighAnsi Microsoft YaHei, EastAsia Microsoft YaHei }); Run run new Run(); run.Append(runProps); run.Append(new Text(中文內(nèi)容));Fonts的Ascii管西文字符HighAnsi管擴(kuò)展字符EastAsia才管中文。只設(shè) Ascii 的話中文依舊可能亂碼。我曾在某個(gè)報(bào)表項(xiàng)目里排查大半天最后發(fā)現(xiàn)是服務(wù)器上缺少中文字體把 RunProperties 顯式指定后問(wèn)題才解決。5.5 TableProperties 子元素順序不對(duì)樣式時(shí)靈時(shí)不靈現(xiàn)象同樣的代碼把 TableProperties 放在不同位置后有時(shí) Word 顯示邊框有時(shí)邊框完全消失而且不報(bào)任何錯(cuò)?？雌饋?lái)很像玄學(xué)。原因Word 解析 OOXML 的tblPr和tcPr時(shí)對(duì)子元素順序有強(qiáng)制要求。OpenXml SDK 的構(gòu)造函數(shù)重載一般能保證順序但手工多次 Append 就很容易打亂。順序不符時(shí)Word 會(huì)靜默忽略部分屬性不給出錯(cuò)誤提示。解決手工構(gòu)造 TableProperties 時(shí)按下面的順序追加常用子元素TableStyle、TableJustification、TableWidth、TableBorders 等。最穩(wěn)妥的方式是用構(gòu)造函數(shù)一次性傳參順序即 schema 順序TableProperties tblProp new TableProperties( new TableWidth() { Type TableWidthUnitValues.Dxa, Width 8500 }, new TableJustification() { Val TableRowAlignmentValues.Center }, new TableBorders( new TopBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 }, new BottomBorder() { Val new EnumValueBorderValues(BorderValues.Single), Size 4 } ) );如果屬性不生效別靠猜用 OpenXmlValidator 把錯(cuò)誤列出來(lái)它連哪個(gè)元素的順序錯(cuò)了都能告訴你。這個(gè)習(xí)慣我是在被 Word 的“修復(fù)文檔”彈窗教育了兩次之后才養(yǎng)成的。6. 收尾進(jìn)階指定位置插入表格、自動(dòng)驗(yàn)證和重復(fù)表頭的完整組合基礎(chǔ)表格能加之后實(shí)際交付往往會(huì)遇到三個(gè)高頻需求表格不要總出現(xiàn)在文末、長(zhǎng)表格要跨頁(yè)重復(fù)表頭、生成的文件不能一打開(kāi)就提示修復(fù)。把這三個(gè)技巧串起來(lái)基本能覆蓋大多數(shù)批量導(dǎo)出場(chǎng)景。第一個(gè)技巧在指定位置插入表格。Body.Append(table)只能把表格追加到文檔末尾不符合業(yè)務(wù)里“在第三段后面插一張表”的要求。常見(jiàn)做法是先定位到目標(biāo)段落再用InsertAfterSelf插到它后面Paragraph target body.DescendantsParagraph() .FirstOrDefault(p p.InnerText.Contains(插入點(diǎn))); if (target ! null) { target.InsertAfterSelf(table); }注意 table 如果已經(jīng)被 Append 過(guò)再次插入會(huì)報(bào)元素已存在異常。我通常先把表格構(gòu)建好再?zèng)Q定插入位置只插一次。第二個(gè)技巧表頭跨頁(yè)重復(fù)。把第一行聲明為 TableHeader 即可TableHeader headerRow new TableHeader(); foreach (string headerText in headerArray) { headerRow.Append(BuildHeaderCell(headerText)); } table.InsertAt(headerRow, 0);這里假設(shè) table 里還沒(méi)有任何行或者你已經(jīng)先把原來(lái)的表頭行清掉。TableHeader是 TableRow 的子類所以插入邏輯和普通行一致。第三個(gè)技巧也是我每次寫(xiě) OpenXml 必做的一步保存前用 OpenXmlValidator 驗(yàn)證結(jié)構(gòu)。使用前需要引入DocumentFormat.OpenXml.Validation命名空間。這個(gè)驗(yàn)證器能發(fā)現(xiàn)單元格層級(jí)、屬性順序、多余嵌套等問(wèn)題省去在 Word 里反復(fù)試錯(cuò)using DocumentFormat.OpenXml.Validation; using (WordprocessingDocument doc WordprocessingDocument.Open(filePath, true)) { var validator new OpenXmlValidator(); var errors validator.Validate(doc).ToList(); foreach (var error in errors) { Console.WriteLine(${error.Path} - {error.Description}); } }以前我不太信任驗(yàn)證器總覺(jué)得手工寫(xiě)的代碼自己心里有數(shù)。直到有一次交付的文檔被對(duì)方打開(kāi)后提示“文件已損壞是否修復(fù)”才意識(shí)到檢查工具比肉眼可靠。從那以后每次生成完 docx我都會(huì)在單元測(cè)試?yán)锱芤槐?OpenXmlValidator再解壓 document.xml 看一眼表格段落的位置。這套流程看著多兩步實(shí)際上省掉了大量返工。希望這些記錄對(duì)你也有用。本文還有配套的精品資源點(diǎn)擊獲取