將很早之前寫的一個小元件重新整理優化一下，做成一個通用的功能。適用於匯出資料庫的結構（表、欄位等）到Word或將體檢資料自動生成Word版的體檢報告等。程式碼：Github

一、主要需要完成功能:

1. 靈活的配置規則及word樣式設定（文字、表格、圖表、顏色等）.

2. 支援表格.

3. 支援圖表.

4. 支援章節內容迴圈生成.

5. 支援目錄.

6.支援文件結構圖

7.更新指定位置的文字

8.支援pdf匯出.

最後結果如下:

                                                                            圖一

                                    圖二

                                         圖三

二、需求分析與實現方式

　  功能主要涉及3個比較重要的部分：資料來源、Word樣式、配置規則。 

     為了簡單,資料來源決定採用一個儲存過程返回Dataset的方式, 整張報告的資料來源於此Dataset的多個Datatable.

　 樣式與配置：首先想到的是寫一個config檔案，所有配置都放到一個檔案裡，然後將資料按照這個規則生成word。但無疑這樣的配置項太多了，關鍵是“樣式”問題，比如字型、顏色、表格寬度.....想想就頭大。而且沒有“所見即所得”的效果，配置完都不知道啥樣。

後來決定採取修改的方式, 先以一個word檔案作為模板，在模板中定義好上面提到的“樣式”，然後在模板中做一個個標記，然後將資料按照規則更新到對應的標記。

                                                       圖四

    而這個標記我們用到了word的一個叫【書籤】的功能，開啟word按ctrl+shift+F5, 開啟書籤功能，如下圖：

                                 圖五

這樣將【規則】通過一系列規則的【書籤】定義到word模板中。

三、規則配置

　　思路確定了，那就開始設計如何通過【書籤】將規則定義到word模板中去，這裡決定將所有規則都通過【書籤】實現，而放棄config檔案的方式，這個更統一而且直觀一些。

A.迴圈

      以圖四為例，資料庫有多少張表是不固定的，我們在製作模板的時候不可能先畫好N（N為表的總數）個表格等待資料填充， 這裡就會需要遍歷資料來源中提供的所有表結構資料，然後逐一形成表格。這裡就需要將圖四中的表格迴圈一下，自動複製生成多個這樣的表格。當然，這只是一種情況，還有可能會出現迴圈巢狀迴圈的情況，那麼我將這個迴圈定義成一個書籤的時候按照這樣的格式：

      loop_級別_表序號_filter_名稱

含義如下：

     loop：代表這是一個迴圈。

     級別：預設文件級別為0，出現的第一層迴圈為1，其內部若再次巢狀迴圈則級別為2，依次類推。

     表序號：取Dataset中的第幾張表(從1開始)

     filter：迴圈的時候可能會用到對datatable的查詢過濾，在此寫出，多個欄位用XX隔開(因為此處不允許有下劃線外其他特殊字元, 就用這個XX吧 )

     名稱：loop名稱，方便與其他 loop區別

 B.更新指定位置的文字

    如圖四中的【伺服器名】、【表總數】等，只需要替換對應的文字即可：

    label_級別_名稱

含義如下：

     label：代表這是一個label。

     級別：預設文件級別為0，出現的第一層迴圈為1，其內部若再次巢狀迴圈則級別為2，依次類推。

     名稱：label名稱

     注意這裡省略了表序號，當級別為0的時候 ，自動取最後一個datatable中的資料，因為這個label經常會用到其他表彙總的資料，可能會用到之前幾張表的資料，所以放在其他表都處理好後。當級別為1的時候，自然取該級別迴圈的行資料。

C.表格

     表格的配置原本也想對錶格新增書籤,後來發現有個表格屬性, 覺得寫在這裡更好一些。

 如上圖所示，【標題】格式為：table_級別_取Dataset中的第幾張表(從1開始)_filter欄位多個用XX隔開(此處不允許有下劃線外其他特殊字元, 就用這個XX吧 )_名稱

【說明】為可選項，若需要合計行, 則需要標識, summary或縮寫s: [合計]行是模板中表格的第幾行   summaryfilter或縮寫sf:資料集進一步filter到summary行的條件(因為一個表格只取一個Datatable,通過一個標識指定了哪些datarow是用來作為合計的)

D.圖表

同樣為了方便將配置寫在了【標題】，圖表生成後會將名稱修改過來。

配置格式為:chart_級別_取Dataset中的第幾張表(從1開始)_filter欄位多個用XX隔開(此處不允許有下劃線外其他特殊字元, 就用這個XX吧 )_chart名稱_是否將Datatable的columnName作為第一行_從datatable第幾列開始(列起始為1)_截止列，

如下圖所示配置即可。

E.目錄

無需標識, 模板中新增目錄, 當內容處理完成之後, 會根據處理後的結果動態更新目錄.

四、主要程式碼

  1 using System;
  2 using System.Collections.Generic;
  3 using System.Data;
  4 using System.Diagnostics;
  5 using System.IO;
  6 using System.Linq;
  7 using System.Reflection;
  8 using Excel = Microsoft.Office.Interop.Excel;
  9 using Word = Microsoft.Office.Interop.Word;
 10 
 11 namespace FlyLolo.WordReport.Demo
 12 {
 13     public class WordReportHelper
 14     {
 15         private Word.Application wordApp = null;
 16         private Word.Document wordDoc = null;
 17         private DataSet dataSource = null;
 18         private object line = Word.WdUnits.wdLine;
 19         private string errorMsg = "";
 20 
 21         /// <summary>
 22         /// 根據模板檔案,建立資料報告
 23         /// </summary>
 24         /// <param name="templateFile">模板檔名(含路徑)</param>
 25         /// <param name="newFilePath">新檔案路徑)</param>
 26         /// <param name="dataSource">資料來源,包含多個datatable</param>
 27         /// <param name="saveFormat">新檔案格式:</param>
 28         public bool CreateReport(string templateFile, DataSet dataSource, out string errorMsg, string newFilePath, ref string newFileName, int saveFormat = 16)
 29         {
 30             this.dataSource = dataSource;
 31             errorMsg = this.errorMsg;
 32             bool rtn = OpenTemplate(templateFile)
 33                 && SetContent(new WordElement(wordDoc.Range(), dataRow: dataSource.Tables[dataSource.Tables.Count - 1].Rows[0]))
 34                 && UpdateTablesOfContents()
 35                 && SaveFile(newFilePath, ref newFileName, saveFormat);
 36 
 37             CloseAndClear();
 38             return rtn;
 39         }
 40 
 41         /// <summary>
 42         /// 開啟模板檔案
 43         /// </summary>
 44         /// <param name="templateFile"></param>
 45         /// <returns></returns>
 46         private bool OpenTemplate(string templateFile)
 47         {
 48             if (!File.Exists(templateFile))
 49             {
 50                 return false;
 51             }
 52 
 53             wordApp = new Word.Application();
 54             wordApp.Visible = true;//使文件可見,除錯用
 55             wordApp.DisplayAlerts = Word.WdAlertLevel.wdAlertsNone;
 56             object file = templateFile;
 57             wordDoc = wordApp.Documents.Open(ref file, ReadOnly: false);
 58             return true;
 59         }
 60 
 61         /// <summary>
 62         /// 為指定區域寫入資料
 63         /// </summary>
 64         /// <param name="element"></param>
 65         /// <returns></returns>
 66         private bool SetContent(WordElement element)
 67         {
 68             string currBookMarkName = string.Empty;
 69             string startWith = "loop_" + (element.Level + 1).ToString() + "_";
 70             foreach (Word.Bookmark item in element.Range.Bookmarks)
 71             {
 72                 currBookMarkName = item.Name;
 73 
 74                 if (currBookMarkName.StartsWith(startWith) && (!currBookMarkName.Equals(element.ElementName)))
 75                 {
 76                     SetLoop(new WordElement(item.Range, currBookMarkName, element.DataRow, element.GroupBy));
 77                 }
 78 
 79             }
 80 
 81             SetLabel(element);
 82 
 83             SetTable(element);
 84 
 85             SetChart(element);
 86 
 87             return true;
 88         }
 89 
 90         /// <summary>
 91         /// 處理迴圈
 92         /// </summary>
 93         /// <param name="element"></param>
 94         /// <returns></returns>
 95         private bool SetLoop(WordElement element)
 96         {
 97             DataRow[] dataRows = dataSource.Tables[element.TableIndex].Select(element.GroupByString);
 98             int count = dataRows.Count();
 99             element.Range.Select();
100 
101             //第0行作為模板  先從1開始  迴圈後處理0行;
102             for (int i = 0; i < count; i++)
103             {
104 
105                 element.Range.Copy();  //模板loop複製
106                 wordApp.Selection.InsertParagraphAfter();//換行 不會清除選中的內容,TypeParagraph 等同於回車,若當前有選中內容會被清除. TypeParagraph 會跳到下一行,InsertParagraphAfter不會, 所以movedown一下.
107                 wordApp.Selection.MoveDown(ref line, Missing.Value, Missing.Value);
108                 wordApp.Selection.Paste(); //換行後貼上複製內容
109                 int offset = wordApp.Selection.Range.End - element.Range.End; //計算偏移量
110 
111                 //複製書籤,書籤名 = 模板書籤名 + 複製次數
112                 foreach (Word.Bookmark subBook in element.Range.Bookmarks)
113                 {
114                     if (subBook.Name.Equals(element.ElementName))
115                     {
116                         continue;
117                     }
118 
119                     wordApp.Selection.Bookmarks.Add(subBook.Name + "_" + i.ToString(), wordDoc.Range(subBook.Start + offset, subBook.End + offset));
120                 }
121 
122                 SetContent(new WordElement(wordDoc.Range(wordApp.Selection.Range.End - (element.Range.End - element.Range.Start), wordApp.Selection.Range.End), element.ElementName + "_" + i.ToString(), dataRows[i], element.GroupBy));
123             }
124 
125             element.Range.Delete();
126 
127             return true;
128         }
129 
130         /// <summary>
131         /// 處理簡單Label
132         /// </summary>
133         /// <param name="element"></param>
134         /// <returns></returns>
135         private bool SetLabel(WordElement element)
136         {
137             if (element.Range.Bookmarks != null && element.Range.Bookmarks.Count > 0)
138             {
139                 string startWith = "label_" + element.Level.ToString() + "_";
140                 string bookMarkName = string.Empty;
141                 foreach (Word.Bookmark item in element.Range.Bookmarks)
142                 {
143                     bookMarkName = item.Name;
144 
145                     if (bookMarkName.StartsWith(startWith))
146                     {
147                         bookMarkName = WordElement.GetName(bookMarkName);
148 
149                         item.Range.Text = element.DataRow[bookMarkName].ToString();
150                     }
151                 }
152             }
153 
154             return true;
155         }
156 
157         /// <summary>
158         /// 填充Table
159         /// </summary>
160         /// <param name="element"></param>
161         /// <returns></returns>
162         private bool SetTable(WordElement element)
163         {
164             if (element.Range.Tables != null && element.Range.Tables.Count > 0)
165             {
166                 string startWith = "table_" + element.Level.ToString() + "_";
167                 foreach (Word.Table table in element.Range.Tables)
168                 {
169                     if (!string.IsNullOrEmpty(table.Title) && table.Title.StartsWith(startWith))
170                     {
171                         WordElement tableElement = new WordElement(null, table.Title, element.DataRow);
172 
173                         TableConfig config = new TableConfig(table.Descr);
174 
175                         object dataRowTemplate = table.Rows[config.DataRow];
176                         Word.Row SummaryRow = null;
177                         DataRow SummaryDataRow = null;
178                         DataTable dt = dataSource.Tables[tableElement.TableIndex];
179                         DataRow[] dataRows = dataSource.Tables[tableElement.TableIndex].Select(tableElement.GroupByString); ;
180 
181                         if (config.SummaryRow > 0)
182                         {
183                             SummaryRow = table.Rows[config.SummaryRow];
184                             SummaryDataRow = dt.Select(string.IsNullOrEmpty(tableElement.GroupByString) ? config.SummaryFilter : tableElement.GroupByString + " and  " + config.SummaryFilter).FirstOrDefault();
185                         }
186 
187                         foreach (DataRow row in dataRows)
188                         {
189                             if (row == SummaryDataRow)
190                             {
191                                 continue;
192                             }
193 
194                             Word.Row newRow = table.Rows.Add(ref dataRowTemplate);
195                             for (int j = 0; j < table.Columns.Count; j++)
196                             {
197                                 newRow.Cells[j + 1].Range.Text = row[j].ToString(); ;
198                             }
199 
200                         }
201 
202                         ((Word.Row)dataRowTemplate).Delete();
203 
204                         if (config.SummaryRow > 0 && SummaryDataRow != null)
205                         {
206                             for (int j = 0; j < SummaryRow.Cells.Count; j++)
207                             {
208                                 string temp = SummaryRow.Cells[j + 1].Range.Text.Trim().Replace("\r\a", "");
209 
210                                 if (!string.IsNullOrEmpty(temp) && temp.Length > 2 && dt.Columns.Contains(temp.Substring(1, temp.Length - 2)))
211                                 {
212                                     SummaryRow.Cells[j + 1].Range.Text = SummaryDataRow[temp.Substring(1, temp.Length - 2)].ToString();
213                                 }
214                             }
215                         }
216 
217                         table.Title = tableElement.Name;
218                     }
219 
220 
221                 }
222             }
223 
224             return true;
225         }
226 
227         /// <summary>
228         /// 處理圖表
229         /// </summary>
230         /// <param name="element"></param>
231         /// <returns></returns>
232         private bool SetChart(WordElement element)
233         {
234             if (element.Range.InlineShapes != null && element.Range.InlineShapes.Count > 0)
235             {
236                 List<Word.InlineShape> chartList = element.Range.InlineShapes.Cast<Word.InlineShape>().Where(m => m.Type == Word.WdInlineShapeType.wdInlineShapeChart).ToList();
237                 string startWith = "chart_" + element.Level.ToString() + "_";
238                 foreach (Word.InlineShape item in chartList)
239                 {
240                     Word.Chart chart = item.Chart;
241                     if (!string.IsNullOrEmpty(chart.ChartTitle.Text) && chart.ChartTitle.Text.StartsWith(startWith))
242                     {
243                         WordElement chartElement = new WordElement(null, chart.ChartTitle.Text, element.DataRow);
244 
245                         DataTable dataTable = dataSource.Tables[chartElement.TableIndex];
246                         DataRow[] dataRows = dataTable.Select(chartElement.GroupByString);
247 
248                         int columnCount = dataTable.Columns.Count;
249                         List<int> columns = new List<int>();
250 
251                         foreach (var dr in dataRows)
252                         {
253                             for (int i = chartElement.ColumnStart == -1 ? 0 : chartElement.ColumnStart - 1; i < (chartElement.ColumnEnd == -1 ? columnCount : chartElement.ColumnEnd); i++)
254                             {
255                                 if (columns.Contains(i) || dr[i] == null || string.IsNullOrEmpty(dr[i].ToString()))
256                                 {
257 
258                                 }
259                                 else
260                                 {
261                                     columns.Add(i);
262                                 }
263                             }
264                         }
265                         columns.Sort();
266                         columnCount = columns.Count;
267                         int rowsCount = dataRows.Length;
268 
269                         Word.ChartData chartData = chart.ChartData;
270 
271                         //chartData.Activate();
272                         //此處有個比較疑惑的問題, 不執行此條,生成的報告中的圖表無法再次右鍵編輯資料. 執行後可以, 但有兩個問題就是第一會彈出Excel框, 處理完後會自動關閉. 第二部分chart的資料range設定總不對
273                         //不知道是不是版本的問題, 誰解決了分享一下,謝謝
274 
275                         Excel.Workbook dataWorkbook = (Excel.Workbook)chartData.Workbook;
276                         dataWorkbook.Application.Visible = false;
277 
278                         Excel.Worksheet dataSheet = (Excel.Worksheet)dataWorkbook.Worksheets[1];
279                         //設定範圍  
280                         string a = (chartElement.ColumnNameForHead ? rowsCount + 1 : rowsCount) + "|" + columnCount;
281                         Console.WriteLine(a);
282 
283                         Excel.Range tRange = dataSheet.Range["A1", dataSheet.Cells[(chartElement.ColumnNameForHead ? rowsCount + 1 : rowsCount), columnCount]];
284                         Excel.ListObject tbl1 = dataSheet.ListObjects[1];
285                         //dataSheet.ListObjects[1].Delete(); //想過重新刪除再新增  這樣 原有資料清掉了, 但覺得效能應該會有所下降
286                         //Excel.ListObject tbl1 = dataSheet.ListObjects.AddEx();
287                         tbl1.Resize(tRange);
288                         for (int j = 0; j < rowsCount; j++)
289                         {
290                             DataRow row = dataRows[j];
291                             for (int k = 0; k < columnCount; k++)
292                             {
293                                 dataSheet.Cells[j + 2, k + 1].FormulaR1C1 = row[columns[k]];
294                             }
295                         }
296 
297                         if (chartElement.ColumnNameForHead)
298                         {
299                             for (int k = 0; k < columns.Count; k++)
300                             {
301                                 dataSheet.Cells[1, k + 1].FormulaR1C1 = dataTable.Columns[columns[k]].ColumnName;
302                             }
303                         }
304                         chart.ChartTitle.Text = chartElement.Name;
305                         //dataSheet.Application.Quit();
306                     }
307                 }
308             }
309 
310             return true;
311         }
312 
313         /// <summary>
314         /// 更新目錄
315         /// </summary>
316         /// <returns></returns>
317         private bool UpdateTablesOfContents()
318         {
319             foreach (Word.TableOfContents item in wordDoc.TablesOfContents)
320             {
321                 item.Update();
322             }
323 
324             return true;
325         }
326 
327         /// <summary>
328         /// 儲存檔案
329         /// </summary>
330         /// <param name="newFilePath"></param>
331         /// <param name="newFileName"></param>
332         /// <param name="saveFormat"></param>
333         /// <returns></returns>
334         private bool SaveFile(string newFilePath, ref string newFileName, int saveFormat = 16)
335         {
336             if (string.IsNullOrEmpty(newFileName))
337             {
338                 newFileName = DateTime.Now.ToString("yyyyMMddHHmmss");
339 
340                 switch (saveFormat)
341                 {
342                     case 0:// Word.WdSaveFormat.wdFormatDocument
343                         newFileName += ".doc";
344                         break;
345                     case 16:// Word.WdSaveFormat.wdFormatDocumentDefault
346                         newFileName += ".docx";
347                         break;
348                     case 17:// Word.WdSaveFormat.wdFormatPDF
349                         newFileName += ".pdf";
350                         break;
351                     default:
352                         break;
353                 }
354             }
355 
356             object newfile = Path.Combine(newFilePath, newFileName);
357             object wdSaveFormat = saveFormat;
358             wordDoc.SaveAs(ref newfile, ref wdSaveFormat);
359             return true;
360         }
361 
362         /// <summary>
363         /// 清理
364         /// </summary>
365         private void CloseAndClear()
366         {
367             if (wordApp == null)
368             {
369                 return;
370             }
371             wordDoc.Close(Word.WdSaveOptions.wdDoNotSaveChanges);
372             wordApp.Quit(Word.WdSaveOptions.wdDoNotSaveChanges);
373             System.Runtime.InteropServices.Marshal.ReleaseComObject(wordDoc);
374             System.Runtime.InteropServices.Marshal.ReleaseComObject(wordApp);
375             wordDoc = null;
376             wordApp = null;
377             GC.Collect();
378             KillProcess("Excel", "WINWORD");
379         }
380 
381         /// <summary>
382         /// 殺程序..
383         /// </summary>
384         /// <param name="processNames"></param>
385         private void KillProcess(params string[] processNames)
386         {
387             //Process myproc = new Process();
388             //得到所有開啟的程序  
389             try
390             {
391                 foreach (string name in processNames)
392                 {
393                     foreach (Process thisproc in Process.GetProcessesByName(name))
394                     {
395                         if (!thisproc.CloseMainWindow())
396                         {
397                             if (thisproc != null)
398                                 thisproc.Kill();
399                         }
400                     }
401                 }
402             }
403             catch (Exception)
404             {
405                 //throw Exc;
406                 // msg.Text+=  "殺死"  +  processName  +  "失敗！";  
407             }
408         }
409     }
410 
411     /// <summary>
412     /// 封裝的Word元素
413     /// </summary>
414     public class WordElement
415     {
416         public WordElement(Word.Range range, string elementName = "", DataRow dataRow = null, Dictionary<string, string> groupBy = null, int tableIndex = 0)
417         {
418             this.Range = range;
419             this.ElementName = elementName;
420             this.GroupBy = groupBy;
421             this.DataRow = dataRow;
422             if (string.IsNullOrEmpty(elementName))
423             {
424                 this.Level = 0;
425                 this.TableIndex = tableIndex;
426                 this.Name = string.Empty;
427                 this.ColumnNameForHead = false;
428             }
429             else
430             {
431                 string[] element = elementName.Split('_');
432                 this.Level = int.Parse(element[1]);
433                 this.ColumnNameForHead = false;
434                 this.ColumnStart = -1;
435                 this.ColumnEnd = -1;
436 
437                 if (element[0].Equals("label"))
438                 {
439                     this.Name = element[2];
440                     this.TableIndex = 0;
441                 }
442                 else
443                 {
444                     this.Name = element[4];
445                     this.TableIndex = int.Parse(element[2]) - 1;
446 
447                     if (!string.IsNullOrEmpty(element[3]))
448                     {
449                         string[] filters = element[3].Split(new string[] { "XX" }, StringSplitOptions.RemoveEmptyEntries);
450                         if (this.GroupBy == null)
451                         {
452                             this.GroupBy = new Dictionary<string, string>();
453                         }
454                         foreach (string item in filters)
455                         {
456                             if (!this.GroupBy.Keys.Contains(item))
457                             {
458                                 this.GroupBy.Add(item, dataRow[item].ToString());
459                             }
460 
461                         }
462                     }
463 
464                     if (element[0].Equals("chart") && element.Count() > 5)
465                     {
466                         this.ColumnNameForHead = element[5].Equals("1");
467                         this.ColumnStart = string.IsNullOrEmpty(element[6]) ? -1 : int.Parse(element[6]);
468                         this.ColumnEnd = string.IsNullOrEmpty(element[7]) ? -1 : int.Parse(element[7]);
469                     }
470                 }
471             }
472         }
473 
474         public Word.Range Range { get; set; }
475         public int Level { get; set; }
476         public int TableIndex { get; set; }
477         public string ElementName { get; set; }
478 
479         public DataRow DataRow { get; set; }
480         public Dictionary<string, string> GroupBy { get; set; }
481 
482         public string Name { get; set; }
483 
484         public bool ColumnNameForHead { get; set; }
485         public int ColumnStart { get; set; }
486         public int ColumnEnd { get; set; }
487 
488         public string GroupByString
489         {
490             get
491             {
492                 if (GroupBy == null || GroupBy.Count == 0)
493                 {
494                     return string.Empty;
495                 }
496 
497                 string rtn = string.Empty;
498                 foreach (string key in this.GroupBy.Keys)
499                 {
500                     rtn += "and " + key + " = '" + GroupBy[key] + "' ";
501                 }
502                 return rtn.Substring(3);
503             }
504         }
505 
506         public static string GetName(string elementName)
507         {
508             string[] element = elementName.Split('_');
509 
510 
511             if (element[0].Equals("label"))
512             {
513                 return element[2];
514             }
515             else
516             {
517                 return element[4];
518             }
519         }
520     }
521 
522     /// <summary>
523     /// Table配置項
524     /// </summary>
525     public class TableConfig
526     {
527         public TableConfig(string tableDescr = "")
528         {
529             this.DataRow = 2;
530             this.SummaryRow = -1;
531 
532             if (!string.IsNullOrEmpty(tableDescr))
533             {
534                 string[] element = tableDescr.Split(',');
535                 foreach (string item in element)
536                 {
537                     if (!string.IsNullOrEmpty(item))
538                     {
539                         string[] configs = item.Split(':');
540                         if (configs.Length == 2)
541                         {
542                             switch (configs[0].ToLower())
543                             {
544                                 case "data":
545                                 case "d":
546                                     this.DataRow = int.Parse(configs[1]);
547                                     break;
548                                 case "summary":
549                                 case "s":
550                                     this.SummaryRow = int.Parse(configs[1]);
551                                     break;
552                                 case "summaryfilter":
553                                 case "sf":
554                                     this.SummaryFilter = configs[1];
555                                     break;
556                                 default:
557                                     break;
558                             }
559                         }
560                     }
561                 }
562             }
563 
564         }
565         public int DataRow { get; set; }
566         public int SummaryRow { get; set; }
567         public string SummaryFilter { get; set; }
568     }
569 }