使用iTextSharp来填充PDF模板文件

需求简介：

    遇到了这样一个需求：某公司需要为所有用户的培训生成一个培训记录，过程如下：

    （1）用户在培训完之后会进入到一个填写信息的界面。

    （2）用户填写信息。

    （3）生成PDF格式的培训记录。

    （4）用户下载并打印归档。

思路：

    因为每次培训后生成的PDF文件内容都不完全一样，但是格式却是完全相同的，所以很容易让人联想到使用模板文件。每次只需要提取用户输入的有效信息，然后复制模板、填充模板、弹出下载即可。

解决过程：

    （1）制作模板：我先使用Microsoft Office 2010编辑模板文件，在保存的时候将文件保存为pdf文件。然后用Adobe Acrobat X编辑刚刚生成的PDF文件，把Textbox、Checkbox等域拖动到指定的位置，然后通过预览功能调整各个域的位置和其中文字的字体、大小，完成后保存。模板完成！（我用Google搜索的时候也看到过用OpenOffice来完成模板的，不过没点开看）

    （2）编程填充PDF文件：本人使用的编程语言是C#，所以使用对应的免费开源类库iTextSharp来完成填充的功能。程序的执行过程是：先读取网页中的有效信息，然后打开模板文件填充到模板文件的域中间，最后另存为一个PDF文件。代码见下文。

    （3）服务器端推送文件给浏览器下载。

遇到的问题：

    （1）首先遇到的问题是Checkbox的传参问题。一开始本人是从一些英文网站查看的相关资料，里面在设置Checkbox使用的语句是：pdfFormFields.SetField(“male”, “Yes”); 试了很多遍，结果就是不行，Checkbox并没有被勾选上。后来无奈了点开Checkbox属性中的选项值一栏，发现它有一栏名为导出值，其中的值为“是”。我猜想我的模板由于使用中文版，其中参数的设置也发生了相应的变化，一试之下果然如此。pdfFormFields.SetField(“male”, “是”); 就是行得通。

    （2）显示中文的问题。如果直接把中文字符串设置到PDF模板中去的话中文字符一个都不会显示。Google了一下，应该是亚洲的文字都不能显示，为此还需要两个附加组件：iTextAsianCmaps.dll和iTextAsian.dll。这两个组件可以在sourceforge上面下载。大家不妨参考：http://www.cnblogs.com/haogj/archive/2011/09/05/2167659.html 。

    （3）以为这就好了？差远了！在输入第一句BaseFont.AddToResourceSearch("iTextAsian.dll");的时候有错误？对了！目前iTextSharp最新的版本是5.4.4，也就是我当时使用的版本。估计版本的变迁使得方法的调用也出了问题，于是果断换成了5.1.2的版本。

    （4）改完之后一路顺畅地写完了方法。试验一下，又出错！BaseFont bf = BaseFont.CreateFont("STSong-Light", "UniGB-UCS2-H", BaseFont.EMBEDDED);中的STSong-Light和UniGB-UCS2-H无法被识别！这个问题我直到最后都没能解决（看了好几篇帖子还是没能解决，大家如果有成功的通知小弟一声，谢谢啊！），退而求其次我只好使用TTF 字体。注：使用TTF 字体貌似是在PDF文件中嵌入字体文件，这使得PDF文件体积巨大，成了我的心病。

代码：

    Anyway，代码还是最重要的，以下的静态类用来填充PDF模板：

   1: using System;

   2: using System.Collections.Generic;

   3: using System.Linq;

   4: using System.Web;

   5: using System.Diagnostics;

   6: using System.IO;

   7: using iTextSharp.text.pdf;

   8:  

   9: public class FillPdfTemplate

  10: {

  11:     public static void GetEnPdf(string templatePath, string newFilePath, Dictionary<string, string> parameters)

  12:     {

  13:         PdfReader pdfReader = new PdfReader(templatePath);

  14:         PdfStamper pdfStamper = new PdfStamper(pdfReader, new FileStream(newFilePath,

  15: FileMode.Create));

  16:         //获取域的集合;

  17:         AcroFields pdfFormFields = pdfStamper.AcroFields;

  18:         //为需要赋值的域设置值;

  19:         foreach (KeyValuePair<string, string> parameter in parameters)

  20:         {

  21:             pdfFormFields.SetField(parameter.Key, parameter.Value);

  22:         }

  23:         //这句很重要，如果为false那么生成的PDF文件还能编辑，一定要设为true;

  24:         pdfStamper.FormFlattening = true;

  25:         pdfStamper.Close();

  26:         pdfReader.Close();

  27:     }

  28:  

  29:     public static void GetChPdf(string templatePath, string newFilePath, string iTextAsianCmapsPath, Dictionary<string, string> parameters)

  30:     {

  31:         PdfReader pdfReader = new PdfReader(templatePath);

  32:         PdfStamper pdfStamper = new PdfStamper(pdfReader, new FileStream(newFilePath, FileMode.Create));

  33:         //获取域的集合;

  34:         AcroFields pdfFormFields = pdfStamper.AcroFields;

  35:  

  36:         BaseFont.AddToResourceSearch(iTextAsianCmapsPath);

  37:         //创建中文字体，第一个参数是中文字体的路径，第二个参数表示文字方向水平，第三个貌似是字体嵌入PDF文件;

  38:         BaseFont baseFT = BaseFont.CreateFont(@"C:\Windows\Fonts\simsun.ttc,1", BaseFont.IDENTITY_H, BaseFont.EMBEDDED);

  39:         foreach (KeyValuePair<string, string> parameter in parameters)

  40:         {

  41:             //要输入中文就要设置域的字体;

  42:             pdfFormFields.SetFieldProperty(parameter.Key, "textfont", baseFT, null);

  43:             //为需要赋值的域设置值;

  44:             pdfFormFields.SetField(parameter.Key, parameter.Value);

  45:         }

  46:         //这句很重要，如果为false那么生成的PDF文件还能编辑，一定要设为true;

  47:         pdfStamper.FormFlattening = true;

  48:         pdfStamper.Close();

  49:         pdfReader.Close();

  50:     }

  51: }

下面是参数的获取和调用的过程和推送PDF文件下载的方法：

   1: protected void btnDownLoad_Click(object sender, EventArgs e)

   2: {

   3:     string position = Text1.Value;

   4:     string venue = Text2.Value;

   5:     string method = Text3.Value;

   6:     string date = Text4.Value;

   7:     string teacher = Text5.Value;

   8:     string content = TextArea1.Value;

   9:     string examination = Checkbox1.Checked ? "是" : "否";

  10:     string selfassessment = Checkbox2.Checked ? "是" : "否";

  11:     string certificate = Checkbox3.Checked ? "是" : "否";

  12:     string etc = Checkbox4.Checked ? "是" : "否";

  13:     string trainee = Text6.Value;

  14:  

  15:     Dictionary<string, string> dict = new Dictionary<string, string>();

  16:     dict.Add("TextPosition", position);

  17:     dict.Add("TextVenue", venue);

  18:     dict.Add("TextMethod", method);

  19:     dict.Add("TextDate", date);

  20:     dict.Add("TextTeacher", teacher);

  21:     dict.Add("TextContent", content);

  22:     dict.Add("TextTrainee", trainee);

  23:     dict.Add("CheckBoxExamination", examination);

  24:     dict.Add("CheckBoxSelf-assessment", selfassessment);

  25:     dict.Add("CheckBoxCertificate", certificate);

  26:     dict.Add("CheckBoxEtc", etc);

  27:  

  28:     string template = Server.MapPath("~/PDFTemplate/ch.pdf");

  29:     string newFile = Server.MapPath("~/PDFTemplate") + "\\" + Session["UserID"].ToString() + ".pdf";

  30:     string iTextAsianCmaps = Server.MapPath("~/Libs/iTextAsianCmaps.dll");

  31:     TrainingRecordToPDF.GetChPdf(template, newFile, iTextAsianCmaps, dict);

  32:  

  33:     OutFile(newFile);

  34: }

  35:  

  36: public void OutFile(string  filename)

  37: {

  38:     System.IO.FileInfo file = new System.IO.FileInfo(filename);

  39:     Response.Clear();

  40:     Response.Charset = "GB2312";

  41:     Response.ContentEncoding = System.Text.Encoding.UTF8;

  42:     Response.AddHeader("Content-Disposition", "attachment; filename=" + Server.UrlEncode(file.Name));

  43:     Response.AddHeader("Content-Length", file.Length.ToString());

  44:     Response.ContentType = "application/x-bittorrent";

  45:     Response.WriteFile(file.FullName);

  46:     Response.End();  

  47:  

  48: }