Display Chinese Characters in PDF created by iTextSharp
Introduction
I have been using iTextSharp for sometime now but had not been able to create a dynamic PDF that can display both English and Chinese characters successfully until today. There are not many writings out there that would give me a complete coverage on how this is done, so I figured it will be beneficial to folks who are still struggling like I was that I summarize all the important steps in one post for easier reference on this tricky issue. Even though my case only deals with Simplified Chinese characters, the same technique is applicable to any double-byte Unicode character set, I believe.
There is plenty of documentation about how to use the iTextSharp API to create dynamic PDF, so here I will only focus on what is generally missing in those web posts – getting Chinese or Asian characters in general to display correctly alongside with English ones.
Getting the API
Get the latest version of iTextSharp.dll from here. Once downloaded and unzipped, there is only one file itextsharp.dll; I added a reference to it in my C# project and that was it. I also downloaded iTextAsian.dll and iTextAsianCmaps.dll (from the Extras link on the same download page for iTextSharp.dll) and added references to them, but it turned out I did not need them at all for what I wanted to accomplish, so later I removed them from the project.
Getting the Font File
This was a turning point for me and everything turned out just fine after I downloaded the correct TTF file for the Simplified Chinese characters I wanted to display. There are many font files for the Simplified Chinese language (used mostly in mainland China); my eyes almost dried up after exhaustive Google searches, and I used a trick in Microsoft Word to help me sort this out – I opened Word, switched the input language to Simplified Chinese, and started typing in a few Simplified Chinese letters into the document. When I looked at the Font faces dropdown box on the top-left corner of the menu bar, it automatically changed from the default “Calibri” to “SimSun”, so that settled it – “SimSun.ttf” was what I wanted to get. I then simply typed “simsun.ttf” on the Google search box and picked the top one from the results: http://www.gamefront.com/files/16488629/simsun.ttf/. There is no need to install the font file. I just placed it in a “Fonts” folder (you can name it whatever) inside my ASP.NET project that is accessible by the runtime ASP.NET code.
Generating a Mixed-Language PDF
Now, it’s show time. In this theme, I have an ASP.NET grid view that contains both English and Chinese texts that are pulled from a SQL Server 2008 database. This is a calendar displaying school events and schedules; so it is natural that a “Save as PDF” link is displayed here to allow the user to grab a copy of the school calendar to go. It was quite straightforward to accomplish this, if there were no Chinese characters involved - I wrapped the grid view data into a DataTable
object and passed it to a pre-written function called ExportPdfTable
that in turn made the appropriate iTextSharp API calls to carry out the dirty work. Below is the code snippet that traverses the DataTable
object and spits out a PDF document on the fly:
…
using iTextSharp.text
using iTextSharp.text.pdf;
..
/// <summary>
/// Print a table to a Pdf file in tabular format,
/// with header image and text on every page
/// </summary>
/// <param name="PdfFileName">This is pyhsical file name
/// of Pdf document that you wanto write to</param>
/// <param name="dt">Datatable that contain the data to print</param>
/// <param name="DocTitle">This is the title of the
/// document to be printed once on first page</param>
/// <param name="PageHeader">Header text to go
/// with header image on every page</param>
/// <param name="HeaderImgPath">the physical file path of a image
/// that you want to print out on every page header</param>
/// <returns></returns>
public static bool ExportPdfTable(string PdfFileName, DataTable dt,
string DocTitle,string PageHeader,string HeaderImgPath)
{
Document doc = new Document(); //iTextSharp document
try
{
string physicalFile = PdfFileName;
PdfWriter pw=PdfWriter.GetInstance(doc,
new FileStream(physicalFile, FileMode.Create));
//prepare for inserting header on every page, using Pageevent
//DocumentEevent e = new DocumentEevent(HeaderImgPath, PageHeader);
//pw.PageEvent = e;
doc.Open();
if (PageHeader.Length > 0)
doc.Add(new Paragraph(new Phrase("")));
if (DocTitle.Length > 0)
doc.Add(new Phrase(DocTitle));
if (dt.Columns.Count == 0) return false;
int cols = dt.Columns.Count;
int rows = dt.Rows.Count;
//prepare the table object
PdfPTable t = new PdfPTable(cols);
t.WidthPercentage = 100;
//cell object
PdfPCell c;
//Use BaseFont to load unicode fonts like Simplified Chinese font
string fontpath = System.Web.HttpContext.Current.Request.PhysicalApplicationPath +
"\\includes\\fonts\\simsun.ttf";
//"simsun.ttf" file was downloaded from web and placed in the folder
BaseFont bf = BaseFont.CreateFont(fontpath,BaseFont.IDENTITY_H,
BaseFont.EMBEDDED);
//create new font based on BaseFont
Font fontContent = new Font(bf, 11);
Font fontHeader = new Font(bf, 12);
//write header
for (int j = 0; j < cols; j++)
{
Phrase pr=new Phrase((dt.Columns[j].Caption != null &&
dt.Columns[j].Caption.Length > 0) ? dt.Columns[j].Caption :
dt.Columns[j].ColumnName,fontHeader);
c = new PdfPCell(pr);
c.PaddingBottom = 5f;
c.PaddingTop = 5f;
c.PaddingLeft = 8f;
c.PaddingRight = 8f;
t.AddCell(c);
}
//write table content
for (int i = 0; i < rows; i++)
{
for (int j = 0; j < cols; j++)
{
//c = new Cell(dt.Rows[i][j].ToString());
//c.Header = false;
c = new PdfPCell(new Phrase(dt.Rows[i][j].ToString(),fontContent));
c.PaddingBottom = 5f;
c.PaddingTop = 5f;
c.PaddingLeft = 8f;
c.PaddingRight = 8f;
t.AddCell(c);
}
}
return doc.Add(t);
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
return false;
}
finally
{
doc.Close();
}
}
The four lines that are critical for allowing Chinese characters to show up in the dynamically generated PDF are shighlighted here:
string fontpath =
System.Web.HttpContext.Current.Request.PhysicalApplicationPath +
"\\includes\\fonts\\simsun.ttf";
//"simsun.ttf" file was downloaded from web and placed in the folder
BaseFont bf = BaseFont.CreateFont(fontpath,
BaseFont.IDENTITY_H, BaseFont.EMBEDDED);
//create new font based on BaseFont
Font fontContent = new Font(bf, 11);
Font fontHeader = new Font(bf, 12);
If these four lines are taken out, the function would still output the same good-looking PDF file except that all Chinese characters would disappear completely. The key in creating a correct base font in this case is loading the correct TTF file and setting the encoding to BaseFont.IDENTITY_H
. I tried “UTF-8” and some other values, but none of them seemed to work. I got this tip from a very brief but helpful post at http://stackoverflow.com/questions/1727765/itextsharp-international-text and I am grateful to its author StewBob and to stackoverflow.com that hosted the post.
Deployment
Everything ran perfectly on my local development machine... the PDF file got created and the Chinese characters showed up...but a "That assembly does not allow partially trusted callers." error was thrown after the project was deployed to an external hosting site. What was going on? Well, this was actually not a new problem and had nothing to do with the Chinese font. As it turned out, I was not supposed to just simply upload itextsharp.dll to the hosting server. I needed to download the iTextSharp source files and compile the DLL with some additional security attribute added. So these extra steps were taken to fix this DLL error:
- Downloaded the iTextSharp source files (version 5.xx) from http://sourceforge.net/projects/itextsharp/files/itextsharp/.
- Launched the iTextSharp solution and opened AssemblyInfo.cs and added the following lines to the end of the file:
- Compiled the DLL and copied it to the hosting site's bin folder, and done.
[assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile("")]
[assembly: AssemblyKeyName("")]
//added this atribute to allow the dll to be callable on a hosting website
[assembly: AllowPartiallyTrustedCallers()]
Summary
Wrapping it up, the four key steps are:
- Download the correct font file and place it in a folder inside the web project.
- Create a
BaseFont
with the font file loaded and set the encoding toBaseFont.IDENTITY_H
; also set embedding the font in the PDF document to true (BaseFont.EMBEDDED
). - Create new fonts based on the
BaseFont
and use them inParagraph
orPhrase
constructors. - Make sure when iTextSharp.dll is deployed to the remote hosting server, the DLL must be re-compiled with the "
AllowPartiallyTrustedCallers
" attribute set.
History
- First submitted on 5/12/2011.
发表评论
Thank you ever so for you blog. Really looking forward to read more.
Your page is very cool, i have bookmarked it.
Your site is very interesting, i have bookmarked it.
I'аve recently started a web site, the information you offer on this site has helped me greatly. Thanks for all of your time & work.
Major thanks for the blog post.Really looking forward to read more. Great.
Spot on with this write-up, I really believe this amazing site needs a great deal more attention. I all probably be returning to read more, thanks for the info!
This is a topic that is close to my heart Many thanks! Where are your contact details though?
This awesome blog is no doubt educating and also factual. I have picked a bunch of interesting tips out of it. I ad love to visit it again soon. Thanks a bunch!
Muchos Gracias for your blog article. Want more.
That is a great tip particularly to those fresh to the blogosphere. Short but very precise information Thank you for sharing this one. A must read article!
Wow! This is a great post and this is so true
Terrific work! That is the type of info that are supposed to be shared around the web. Shame on Google for now not positioning this submit upper! Come on over and discuss with my web site. Thanks =)
Thanks for the blog article.Much thanks again. Want more.
Thanks for the article.Really looking forward to read more. Cool.
make this website yourself or did you hire someone to do it for you?
Im thankful for the article post.Much thanks again. Really Cool.
when it comes when it comes to tv fashion shows, i really love Project Runway because it shows some new talents in the fashion industry**
This is really interesting. Thanks for posting it. By the looks of the comments, many others think so too.
Wow! This can be one particular of the most helpful blogs We have ever arrive across on this subject. Basically Wonderful. I am also an expert in this topic so I can understand your effort.
stumbleupon everyday. It as always useful
I really liked your post.Really thank you! Keep writing.
to my friends. I am confident they will be
Really enjoyed this article.Really looking forward to read more. Will read on
Muchos Gracias for your post.Thanks Again. Awesome.
Really appreciate you sharing this article post.Much thanks again. Will read on...
This awesome blog is really interesting and informative. I have discovered a lot of interesting stuff out of this amazing blog. I ad love to visit it every once in a while. Thanks a lot!
Would you be occupied with exchanging hyperlinks?
Well I truly liked reading it. This tip offered by you is very useful for accurate planning.
It as very trouble-free to find out any topic on web as compared to textbooks, as I found this
Utterly pent written content, Really enjoyed looking at.
I value the blog.Really looking forward to read more. Much obliged.
Thanks-a-mundo for the blog post.Really thank you!
We at present do not very personal an automobile however anytime I purchase it in future it all definitely undoubtedly be a Ford style!
On every weekend, we all friends together used to watch show, because fun is also necessary in life.
I visit everyday a few websites and websites to read articles or reviews, except this webpage provides quality based content.
your presentation however I find this topic to be really one thing
I'аve learn some just right stuff here. Definitely price bookmarking for revisiting. I wonder how much effort you set to make the sort of great informative website.
Lovely just what I was searching for.Thanks to the author for taking his clock time on this one.
Wow, great post.Really looking forward to read more. Great.
Whats up! I just want to give a huge thumbs up for the good info you could have right here on this post. I might be coming again to your blog for more soon.
pretty beneficial material, overall I feel this is really worth a bookmark, thanks
Very good article. I am facing some of these issues as well..
May you please prolong them a bit from next time?
uvb treatment I want to write and I wonder how to start a blog for people on this yahoo community..
What the amazing post you ave made. I merely stopped into inform you I truly enjoyed the actual read and shall be dropping by from time to time from right now on.
It as not that I want to duplicate your web site, but I really like the style. Could you tell me which style are you using? Or was it custom made?
There is definately a great deal to find out about this issue. I love all of the points you ave made.
Stunning quest there. What occurred after? Thanks!
Thanks for sharing, this is a fantastic article post. Great.
This is very interesting, You are a very skilled blogger. I ave joined your feed and look forward to seeking more of your great post. Also, I have shared your site in my social networks!