前言
原文引用:http://www.dotblogs.com.tw/joysdw12/archive/2013/01/14/87228.aspx
NPOI 是一個能夠快速讀取EXCEL與產生EXCEL檔案的第三方套件,對於需要產生EXCEL報表的情況下非常好用,以下簡單介紹一下使用方式。
範例
Step 1 下載NPOI Library
請至 CodePlex 下載 NPOI Library ,下載完成後解壓縮如下:
壓縮檔內有一些說明文檔可以先看看,另外包含兩個資料夾 examples 為範例檔、bin 為要加入專案的DLL檔案,在這我使用bin\.net 4.0\資料夾內的DLL檔案,將DLL加入參考至新網站中。
Step 2 建立報表樣版
使用NPOI可以自己動態建立EXCEL也能夠使用EXCEL樣版檔產生報表,在這使用我使用樣版檔的方式建立,首先建立一個 Office 2003 格式的 Excel檔案,將要顯示的相關欄位格式設定好,如下:
樣版製作好後將檔案放入網站下,稍微分一下目錄跟加入一個Default.aspx開始頁面讓之後能夠操作。
Step 3 撰寫報表產生類別
接下來就要開始撰寫程式碼,以下方法於範例中可以取得完整程式碼,這邊只大致說明一下使用方式:
InitReport() 方法
在InitReport方法中,要設定初始化報表的設定如下:
- MaxCol : 總欄位數量,由此範例來看EXCEL共有5欄,但是在這要從0開始計算所以填4
- StartRow : 起始的列,由此範例來看第一列為報表標題第二列為欄為標題所以從第三列開始,但也是從0開始所以填2
- ExportPath : 產生檔案路徑,如要儲存產生的EXCEL這邊就要設定路徑
- ExportFileName : 產生檔案的名稱
- TemplatePath : 樣版檔路徑
- TemplateFileName : 樣版檔案的名稱
- TemplateFilePath : 樣版檔案的完整路徑
01 | private void InitReport() |
05 | ExportPath = "~/Rpt/Export/" ; |
06 | ExportFileName = "ProductReport.xls" ; |
07 | TemplatePath = "~/Rpt/Template/" ; |
08 | TemplateFileName = "TemplateReport.xls" ; |
09 | TemplateFilePath = TemplatePath + TemplateFileName; |
LoadSheet() 方法
在LoadSheet方法中,將會開啟指定的樣板檔,其中 HssfWorkbook.GetSheetAt(0) 這段主要為取得樣版中指定的Sheet Index Number,想用Sheet名稱取得話可以改用 GetSheet(string name) 方法。
因為之後要設定新增列的格式跟字體,所以額外建立 CreateCellStyle 與 CreateFont 物件,之所以不放在InserNewRow()法中產生是因為如每產生一列就新增樣式物件,會造成Excel資源消耗而發生樣式跑掉的問題。
1 | private void LoadSheet() |
3 | FileStream file = new FileStream(HttpContext.Current.Server.MapPath(TemplateFilePath), FileMode.Open, FileAccess.Read); |
4 | HssfWorkbook = new HSSFWorkbook(file); |
5 | Sheet = HssfWorkbook.GetSheetAt(0); |
6 | CellStyle = HssfWorkbook.CreateCellStyle(); |
7 | Font = HssfWorkbook.CreateFont(); |
InsertNewRow() 方法
在InsertNewRow方法中,主要的作用就是動態產生一列新列,產生後設定該列的樣式與字體等等後回傳該列讓後續操作。
01 | private IRow InsertNewRow() |
05 | Sheet.ShiftRows(StartRow, Sheet.LastRowNum, 1); |
06 | row = Sheet.GetRow(StartRow); |
08 | row = Sheet.CreateRow(StartRow); |
09 | for ( int i = 0; i <= MaxCol; i++) |
11 | cell = row.CreateCell(i); |
13 | CellStyle.BorderBottom = BorderStyle.THIN; |
14 | CellStyle.BorderLeft = BorderStyle.THIN; |
15 | CellStyle.BorderRight = BorderStyle.THIN; |
16 | CellStyle.BorderTop = BorderStyle.THIN; |
18 | CellStyle.Alignment = HorizontalAlignment.LEFT; |
19 | CellStyle.VerticalAlignment = VerticalAlignment.CENTER; |
20 | CellStyle.WrapText = true ; |
22 | Font.FontName = "標楷體" ; |
23 | Font.FontHeightInPoints = 12; |
25 | CellStyle.SetFont(Font); |
26 | cell.CellStyle = CellStyle; |
ReportLogic() 方法
在ReportLogic方法中,主要就是報表邏輯的撰寫,此處將依照要產生的報表需求撰寫相關程式碼,直接取得樣版中欄位位置的方法就是使用 Sheet.GetRow(0).GetCell(0).SetCellValue("") 方法,如需要使用Excel的公式的話可以使用 row.GetCell(0).SetCellFormula(string formula) 方法,另外可以看到報表內容部分就是跑回圈取得來源資料後反覆進行[ 新增列 > 指定列的欄位值 ]動作。
01 | private void ReportLogic() |
04 | Sheet.GetRow(0).GetCell(0).SetCellValue( "產品報表" ); |
07 | foreach (ProductDao.ProductEntity entity in GetData()) |
09 | IRow row = InsertNewRow(); |
11 | row.GetCell(0).SetCellValue(entity.ProductID); |
12 | row.GetCell(1).SetCellValue(entity.ProductName); |
13 | row.GetCell(2).SetCellValue(entity.ProductPrice); |
14 | row.GetCell(3).SetCellValue(entity.ProductNumber); |
15 | row.GetCell(4).SetCellFormula( string .Format( "C{0}*D{0}" , StartRow)); |
ExportExcel方法與SaveExcel方法
最後一步當然要將產生的資料輸出,這邊提供了兩種輸出方法
ExprotExcel() 方法為直接將網頁轉換ContentType後輸出,Client端就可以直接跳出EXCEL下載視窗。
SaveExcel() 方法為將先檔案儲存在Server的主機上並且也回傳檔案路徑回來。
01 | public void ExportExcel() |
04 | HttpContext.Current.Response.ContentType = "application/vnd.ms-excel" ; |
05 | HttpContext.Current.Response.AddHeader( "Content-Disposition" , string .Format( "attachment;filename={0}" , ExportFileName)); |
06 | HttpContext.Current.Response.Clear(); |
12 | MemoryStream file = new MemoryStream(); |
13 | HssfWorkbook.Write(file); |
15 | HttpContext.Current.Response.BinaryWrite(file.GetBuffer()); |
16 | HttpContext.Current.Response.End(); |
19 | public string SaveExcel() |
26 | string saveFilePath = ExportPath + ExportFileName; |
28 | FileStream file = new FileStream(HttpContext.Current.Server.MapPath(saveFilePath), FileMode.Create); |
29 | HssfWorkbook.Write(file); |
以上就是一個基本的 NPOI 動態產生 EXCEL 的使用範例,基本上抓下來後依照這種方式作或添加新設定就可以產生EXCEL,而針 NPOI 對於 EXCEL 的操作方法還有很多種設定,例如合併欄、其它函式操作、畫圖形等等的功能可以去參考 NPOI 官方文件網站查詢。
結果:
範例程式碼
TNPOI.rar
參考資料
官方網站