在.NET中使用iTextSharp建立/读取PDF报告： Part I [翻译]
原文地址：Create/Read Advance PDF Report using iTextSharp in C# .NET: Part I By Debopam Pal, 27 Nov 2013html
到PDF原文介绍了iTextSharp这个类库，并演示了一些基本的操做，基本属于入门级别的，惋惜做者并无在编写后续的文章。java
刚好本身也在学习这个类库，想实现一个导出ASPX页面到PDF的功能，如做者所说，网上找到的示例好多都是针对旧版本iTextSharp编写的，还有些驴唇不对马嘴，并且，不少照抄的连验证都省了，一点价值都没有。这篇文章算是详实的入门文章，实例也都基本操做了一遍实现没有问题。c#
ps.：第一次翻译老外的文章，英语水平通常，有些地方词不达意，还望海涵，若是出入但愿帮忙指出。api
文章内容
- 简介
- 要求
- 安装步骤
- 6步建立PDF文档
- 关联PDF文档的页面大小
- 设置PDF文档背景色
- 设置PDF文档边距
- 设置PDF文档文字对齐方式
- 设置PDF文档的元信息或属性
- 建立多页文档
- 从已有文档建立新的PDF文档
- 使用Layer为PDF文档添加水印
- 使用Removing Layer移除刚刚建立Layer水印的PDF文档
- 在建立过程为每一页添加水印
- E在不存盘的状况下，导出/打印/输出PDF文件到客户端
下面内容是在更新版本后添加的: - 设置PDF浏览参数
- 加密PDF文档
- 声明
- 参考文献
- 历史
简介
最近我一直在寻找一个高级的工具来建立复杂的PDF报告用在C#.NET中，我找到了iTextSharp.主要的问题是iTextSharp.缺少文档。好吧，有少许的C#代码例子，可是那些对初学者来讲是不够的而且这些示例代码都是创建在iTextSharp的旧版本上，在最新版本上有不少变化。因此，对初学者来讲转换旧版本到新版本比较困难。此外，我认为假如我写一篇关于iTextSharp的文章，它能帮助我同时也能做为往后的参考，我将为每个功能点书写示例。老实说，在这篇文章，我编写的全部示例，你都能在《iText in Action, Second Edition》这本书的第一节找到，这本书是针对Java开发者编写的。我将在个人文章中解释[从java到c#]这本书余下章节的全部的示例.因此，若是有人对这个库(iTextSharp)感兴趣，这里将是一个好的开始。ruby
想知道关于(iTextSharp)的更多细节，能够经过他们的官方网站了解app
要求
- 编译这个类库，你须要一个C#2008(vs2008)编译器或者更高版本，Visual Studio 2008 or Visual C# 2008 Express Edition
- 这个库代码运行在:
- .NET 2.0
- .NET 3.0
- .NET 3.5
- .NET 4.0
- .NET 4.0 Client Profile
- .NET 4.5
- .NET 4.5 Client Profile
安装
- 你须要安装 NuGet package
或者 你能够从下面这个SourceForge的连接下载DLL，而后参照下面步骤:ide
- 添加引用BlahBlah(步骤以下，翻译掠过). Just see the image below:
- 你须要引入到C#文件中的命名空间:
iTextSharp.textiTextSharp.text.pdf
快速入门
6步建立一个PDF文档:
- Step 1: 建立一个
System.IO.FileStream对象:
FileStream fs = new FileStream("Chapter1_Example1.pdf", FileMode.Create, FileAccess.Write, FileShare.None);
- Step 2: 建立一个
iTextSharp.text.Document对象:
Document doc = new Document();
- Step 3: 建立一个
iTextSharp.text.pdf.PdfWriter对象: 它有助于把Document书写到特定的FileStream:
PdfWriter writer = PdfWriter.GetInstance(doc, fs);
- Step 4: 打开 Document:
doc.Open();
- Step 5: 建立一个 iTextSharp.text.Paragraph 对象并添加到Document里:
doc.Add(new Paragraph("Hello World"));
- Step 6: 关闭 Document:
doc.Close();
关联PDF文档的页面大小:
建立一个特定大小的页面，咱们须要建立一个iTextSharp.text.Rectangle 对象同时传递一个页面大小的参数到它的构造函数里面，下面是定义页面大小的方法:函数
- 第一种定义一个版面大小的方式:
经过定义像素或者英寸定义一个页面尺寸。注意：在iTextSharp里面页面大小的单位是‘point。72point=1英寸。假设咱们须要一个宽度=2英寸&高度=10英寸的PDF文件，那么咱们须要144pt&72pt，让咱们看下该怎么作:
Rectangle rec = new Rectangle(144, 720);
- 第二种定义版面大小的方式:
使用内建的iTextSharp.text.PageSize类定义:Rectangle rec2 = new Rectangle(PageSize.A4);
下面是内建的版面大小。. 完整的页面大小说明连接 Documentation of Page Size:_11X17A0A1A10A2A3A4A4_LANDSCAPEA5A6A7A8A9ARCH_AARCH_BARCH_CARCH_DARCH_EB0B1B10B2B3B4B5B6B7B8B9CROWN_OCTAVOCROWN_QUARTODEMY_OCTAVODEMY_QUARTOEXECUTIVEFLSAFLSEHALFLETTERID_1ID_2ID_3LARGE_CROWN_OCTAVOLARGE_CROWN_QUARTOLEDGERLEGALLEGAL_LANDSCAPELETTERLETTER_LANDSCAPENOTEPENGUIN_LARGE_PAPERBACKPENGUIN_SMALL_PAPERBACKPOSTCARDROYAL_OCTAVOROYAL_QUARTOSMALL_PAPERBACKTABLOID
- 第三种定义版面大小的方式:
反转文档的高度变成宽度&反之亦然:Rectangle rec3 = new Rectangle(PageSize.A4.Rotate());
如今，把刚刚的这个 iTextSharp.text.Rectangle 对象 (任意一个)也就是上面的 'rec',或者 'rec2'或者 'rec3'加入iTextSharp.text.Document's 的构造函数中:工具
Document doc = new Document(rec);
设置PDF文档背景色:
有几种方式来设置背景色:oop
- 第一种方法:
须要使用对象iTextSharp.text.BaseColor. 实例化BaseColor 采用System.Drawing.Color （.NET）对象或者你也能够用传递RGB值的形式来定义:rec.BackgroundColor = new BaseColor(System.Drawing.Color.WhiteSmoke);
- 第二种方法:
须要使用对象iTextSharp.text.pdf.CMYKColor. CMYKColor 经过传递 CMYK 值的方式来构造:rec2.BackgroundColor = new CMYKColor(25, 90, 25, 0);
设置PDF文档边距:
页边距能够像设置版面大小同样来定义
加入咱们设置以下的页边距:
- Left : 0.5 inch
- Right : 1 inch
- Top : 1.5 inch
- Bottom : 2.5 inch
因此咱们须要分别设置页面的 Left, Right, Top, Bottom 页边距使用point单位，由于咱们知道 iTextSharp 中是使用point做为单位的，而且 72 points = 1 inch.
- Left : 36pt => 0.5 inch
- Right : 72pt => 1 inch
- Top : 108pt => 1.5 inch
- Bottom : 180pt => 2.5 inch
实现以下:
Document doc = new Document(PageSize.A4, 36, 72, 108, 180);
设置PDF文档文字对齐方式:
Alignment 是iTextSharp.text.Paragraph对象的属性. iTextSharp 提供了各类对齐方式. 能够经过iTextSharp.text.Element 类设置对其.如下是iTextSharp提供的对齐方式:
ALIGN_BASELINE[^]ALIGN_BOTTOM[^]ALIGN_CENTER[^]ALIGN_JUSTIFIED[^]ALIGN_JUSTIFIED_ALL[^]ALIGN_LEFT[^]ALIGN_MIDDLE[^]ALIGN_RIGHT[^]ALIGN_TOP[^]ALIGN_UNDEFINED[^]
咱们已经知道在 iTextSharp.text.Document 的构造函数中须要iTextSharp.text.Paragraph 对象，因此在建立Paragraph对象之后咱们能够设置它的对齐方式，咱们能够在Document建立过程把Prargraph传递进去.
实现以下:
Paragraph para = new Paragraph("Hello World Hello World Hello World Hello World Hello World Hello World Hello World Hello World Hello World Hello World Hello World");
// Setting paragraph's text alignment using iTextSharp.text.Element class
para.Alignment = Element.ALIGN_JUSTIFIED;
// Adding this 'para' to the Document object
doc.Add(para);
设置PDF文档的元信息或属性:
下面这些PDF文档的元信息 你能够经过iTextSharp.text.Document建立的对象doc(上文的doc)里面的方法来设置:
- Author Name[^]
- Creation Date[^]
- Creator Name[^]
- Header Name & Content[^]
- Keywords[^]
- Langugae[^]
- Producer[^]
- Subject[^]
- Title[^]
下面是他们的一些实现:
// Setting Document properties e.g.
// 1. Title
// 2. Subject
// 3. Keywords
// 4. Creator
// 5. Author
// 6. Header
doc.AddTitle("Hello World example");
doc.AddSubject("This is an Example 4 of Chapter 1 of Book 'iText in Action'");
doc.AddKeywords("Metadata, iTextSharp 5.4.4, Chapter 1, Tutorial");
doc.AddCreator("iTextSharp 5.4.4");
doc.AddAuthor("Debopam Pal");
doc.AddHeader("Nothing", "No Header");
如今，打开一个PDF文档后，右键->属性，你会看到刚才设置的信息:
建立多页文档:
咱们能够经过iTextSharp.text.Document的NewPage()方法建立新页面，咱们来建立5个PDF文档(页面) :
for (int i = 1; i <= 5; i++)
{
doc.NewPage();
doc.Add(new Paragraph(string.Format("This is a page {0}", i)));
}
从已有文档建立新的PDF文档:
咱们可使用iTextSharp.text.pdf.PdfReader对象读取一个PDF文档，而后使用 iTextSharp.text.pdf.PdfStamper对象来把它写到另外一个PDF文档。实现以下:
string originalFile = "Original.pdf";
string copyOfOriginal = "Copy.pdf";
using (FileStream fs = new FileStream(originalFile, FileMode.Create, FileAccess.Write, FileShare.None))
using (Document doc = new Document(PageSize.LETTER))
using (PdfWriter writer = PdfWriter.GetInstance(doc, fs))
{
doc.Open();
doc.Add(new Paragraph("Hi! I'm Original"));
doc.Close();
}
PdfReader reader = new PdfReader(originalFile);
using (FileStream fs = new FileStream(copyOfOriginal, FileMode.Create, FileAccess.Write, FileShare.None))
// Creating iTextSharp.text.pdf.PdfStamper object to write
// Data from iTextSharp.text.pdf.PdfReader object to FileStream object
using (PdfStamper stamper = new PdfStamper(reader, fs)) { }
使用Layer为PDF文档添加水印:
再iTextSharp中，PDF文档建立后能够添加水印，在这里我将使用iTextSharp.text.pdf.PdfLayer为已有的PDF文档（Original.pdf）添加水印。实现以下:
string watermarkedFile = "Watermarked.pdf";
// Creating watermark on a separate layer
// Creating iTextSharp.text.pdf.PdfReader object to read the Existing PDF Document
PdfReader reader1 = new PdfReader(originalFile);
using (FileStream fs = new FileStream(watermarkedFile, FileMode.Create, FileAccess.Write, FileShare.None))
// Creating iTextSharp.text.pdf.PdfStamper object to write Data from iTextSharp.text.pdf.PdfReader object to FileStream object
using (PdfStamper stamper = new PdfStamper(reader1, fs))
{
// Getting total number of pages of the Existing Document
int pageCount = reader1.NumberOfPages;
// Create New Layer for Watermark
PdfLayer layer = new PdfLayer("WatermarkLayer", stamper.Writer);
// Loop through each Page
for (int i = 1; i <= pageCount; i++)
{
// Getting the Page Size
Rectangle rect = reader1.GetPageSize(i);
// Get the ContentByte object
PdfContentByte cb = stamper.GetUnderContent(i);
// Tell the cb that the next commands should be "bound" to this new layer
cb.BeginLayer(layer);
cb.SetFontAndSize(BaseFont.CreateFont(
BaseFont.HELVETICA, BaseFont.CP1252, BaseFont.NOT_EMBEDDED), 50);
PdfGState gState = new PdfGState();
gState.FillOpacity = 0.25f;
cb.SetGState(gState);
cb.SetColorFill(BaseColor.BLACK);
cb.BeginText();
cb.ShowTextAligned(PdfContentByte.ALIGN_CENTER, watermarkText, rect.Width / 2, rect.Height / 2, 45f);
cb.EndText();
// Close the layer
cb.EndLayer();
}
}
实现结果以下:
使用Removing Layer移除刚刚建立Layer水印的PDF文档:
Whenever we add Layer in PDF Document, then the content of the Layer resides under OCG Group. So if I remove this Layer we can remove the content of the Layer also e.g. here it is Watermark Text. To remove all the Layers from PDF Document, you have to remove OCG Group completely from the Document usingreader.Catalog.Remove(PdfName.OCPROPERTIES). Now follow the Steps below to remove the Watermark Text from Layer:
- Read the existing watermarked document using
iTextSharp.text.pdf.PdfReader's object - Taking each Page in the
iTextSharp.text.pdf.PdfDictionary's object usingGetPageN(int pageNumber)method ofiTextSharp.text.pdf.PdfReader's object. - Taking the Content of the Page in the
iTextSharp.text.pdf.PdfArray's object usingGetAsArray(PdfName.CONTENTS)method ofiTextSharp.text.pdf.PdfDictionary's object - Loop through this array and Get each element as
iTextSharp.text.pdf.PRStream's object usingGetAsStream(int arrayIndex)method ofiTextSharp.text.pdf.PdfArray's object - Convert each stream into Bytes using Static method
GetStreamBytes(PRStream stream)ofiTextSharp.text.pdf.PdfReaderclass - Convert these Bytes into String using
System.Text.Encoding.ASCII.GetString(byte[] bytes)method - Search for the String "/OC" and also the
Watermarked Text. If found then remove it by giving it zero length and zero data using two methods:Put()&SetData()ofiTextSharp.text.pdf.PRStreamclass - Write this modified document exists in the
readerto a new document usingiTextSharp.text.pdf.PdfStamper's object
Lets Implement it:
// Removing the layer created above
// 1. First we bind a reader to the watermarked file
// 2. Then strip out a branch of things
// 3. Finally use a simple stamper to write out the edited reader
PdfReader reader2 = new PdfReader(watermarkedFile);
// NOTE: This will destroy all layers in the Document, only use if you don't have any addtional layers
// Remove the OCG group completely from the Document: reader2.Catalog.Remove(PdfName.OCPROPERTIES);
// Clean up the reader, optional
reader2.RemoveUnusedObjects();
// Placeholder variables
PRStream stream;
string content;
PdfDictionary page;
PdfArray contentArray;
// Get the number of pages
int pageCount2 = reader2.NumberOfPages;
// Loop through each page
for (int i = 1; i <= pageCount2; i++)
{
// Get the page
page = reader2.GetPageN(i);
// Get the raw content
contentArray = page.GetAsArray(PdfName.CONTENTS);
if (contentArray != null)
{
// Loop through content
for (int j = 0; j < contentArray.Size; j++)
{
stream = (PRStream)contentArray.GetAsStream(j);
// Convert to a String, NOTE: you might need a different encoding here
content = System.Text.Encoding.ASCII.GetString(PdfReader.GetStreamBytes(stream));
//Look for the OCG token in the stream as well as our watermarked text
if (content.IndexOf("/OC") >= 0 && content.IndexOf(watermarkText) >= 0)
{
//Remove it by giving it zero length and zero data
stream.Put(PdfName.LENGTH, new PdfNumber(0));
stream.SetData(new byte[0]);
}
}
}
}
// Write the content out
using (FileStream fs = new FileStream(unwatermarkedFile,
FileMode.Create, FileAccess.Write, FileShare.None))
using (PdfStamper stamper = new PdfStamper(reader2, fs)) { }
在建立过程为每一页添加水印:
Now, we already know that, watermark cannot be add during Page creation, it have to add after document creation. So, I've created a class PDFWriterEvents which implements the interface iTextSharp.text.pdf.IPdfPageEventand modify the event OnStartPage. This interface contains a set of events from the Openning & to Closing the PDF Document. The events are following:
public void OnOpenDocument(PdfWriter writer, Document document)public void OnCloseDocument(PdfWriter writer, Document document)public void OnStartPage(PdfWriter writer, Document document)public void OnEndPage(PdfWriter writer, Document document)public void OnParagraph(PdfWriter writer, Document document, float paragraphPosition)public void OnParagraphEnd(PdfWriter writer, Document document, float paragraphPosition)public void OnChapter(PdfWriter writer, Document document, float paragraphPosition, Paragraph title)public void OnChapterEnd(PdfWriter writer, Document document, float paragraphPosition)public void OnSection(PdfWriter writer, Document document, float paragraphPosition, int depth, Paragraph title)public void OnSectionEnd(PdfWriter writer, Document document, float paragraphPosition)public void OnGenericTag(PdfWriter writer, Document document, Rectangle rect, String text)
You may modify other events accroding to your needs which occured against a particular action. Let see the which I've created:
// Creating Watermark inside OnStartPage Event by implementing IPdfPageEvent interface
// So that, dusring Page Creation, Watermark will be create
class PDFWriterEvents : IPdfPageEvent
{
string watermarkText;
float fontSize = 80f;
float xPosition = 300f;
float yPosition = 800f;
float angle = 45f;
public PDFWriterEvents(string watermarkText, float fontSize = 80f,
float xPosition = 300f, float yPosition = 400f, float angle = 45f)
{
this.watermarkText = watermarkText;
this.xPosition = xPosition;
this.yPosition = yPosition;
this.angle = angle;
}
public void OnOpenDocument(PdfWriter writer, Document document) { }
public void OnCloseDocument(PdfWriter writer, Document document) { }
public void OnStartPage(PdfWriter writer, Document document)
{
try
{
PdfContentByte cb = writer.DirectContentUnder;
BaseFont baseFont = BaseFont.CreateFont(BaseFont.HELVETICA, BaseFont.WINANSI, BaseFont.EMBEDDED);
cb.BeginText();
cb.SetColorFill(BaseColor.LIGHT_GRAY);
cb.SetFontAndSize(baseFont, fontSize);
cb.ShowTextAligned(PdfContentByte.ALIGN_CENTER, watermarkText, xPosition, yPosition, angle);
cb.EndText();
}
catch (DocumentException docEx)
{
throw docEx;
}
}
public void OnEndPage(PdfWriter writer, Document document) { }
public void OnParagraph(PdfWriter writer, Document document, float paragraphPosition) { }
public void OnParagraphEnd(PdfWriter writer, Document document, float paragraphPosition) { }
public void OnChapter(PdfWriter writer, Document document, float paragraphPosition, Paragraph title) { }
public void OnChapterEnd(PdfWriter writer, Document document, float paragraphPosition) { }
public void OnSection(PdfWriter writer, Document document, float paragraphPosition, int depth, Paragraph title) { }
public void OnSectionEnd(PdfWriter writer, Document document, float paragraphPosition) { }
public void OnGenericTag(PdfWriter writer, Document document, Rectangle rect, String text) { }
}
Lets see how & when you use the object of this class:
using (FileStream fs = new FileStream(
"Watermark_During_Page_Creation.pdf", FileMode.Create, FileAccess.Write, FileShare.None))
using (Document doc = new Document(PageSize.LETTER))
using (PdfWriter writer = PdfWriter.GetInstance(doc, fs))
{
writer.PageEvent = new PDFWriterEvents("This is a Test");
doc.Open();
doc.Add(new Paragraph("This is a page 1"));
doc.Close();
}
See, OnStartPage event called during adding a new paragraph. So I don't need to add watermark later
在不存盘的状况下，导出/打印/输出PDF文件到客户端:
We can create PDF File in memory by creatig System.IO.MemorySystem's object. Lets see:
using (MemoryStream ms = new MemoryStream())
using(Document document = new Document(PageSize.A4, 25, 25, 30, 30))
using(PdfWriter writer = PdfWriter.GetInstance(document, ms))
{
document.Open();
document.Add(new Paragraph("Hello World"));
document.Close();
writer.Close();
ms.Close();
Response.ContentType = "pdf/application";
Response.AddHeader("content-disposition", "attachment;filename=First_PDF_document.pdf");
Response.OutputStream.Write(ms.GetBuffer(), 0, ms.GetBuffer().Length);
}
设置PDF浏览参数:
The values of the different ViewerPreferences were originally stored in iTextSharp.text.pdf.PdfWriter class as an integer constant. You can set the ViewerPreferences by following two ways:
- By setting property
ViewerPreferencesofiTextSharp.text.pdf.PdfWriterclass. To know all theViewerPreferencesand its purpose, please read this first. E.g.-writer.ViewerPreferences = PdfWriter.HideMenubar;
- By calling method
AddViewerPreference(PdfName key, PdfObject value)ofiTextSharp.text.pdf.PdfWriter's object. To know whichvalueis appropiate for whichkey, read thisfirst. E.g.-writer.AddViewerPreference(PdfName.HIDEMENUBAR, new PdfBoolean(true));
加密PDF文档:
By SetEncryption() method of iTextSharp.text.pdf.PdfWriter's object, we can encrypt a PDF document. Read full documentation of this method here. To know all the encryption types, click here. E.g.-
writer.SetEncryption(PdfWriter.STRENGTH40BITS, null, null, PdfWriter.ALLOW_COPY);
声明
Please download the source code for detail. I hope you'll understand as the source code is documented. If any doubt, just post your comment below. Thank you.
参考文献
- iText Official Website
- iText in Action, Second Edition
- Core iText API Documentation
- RubyPdf Blog - iText# in Action
- Create PDFs in ASP.NET - getting started with iTextSharp
- Basic PDF Creation Using iTextSharp - Part I
历史
25th Nov, 2013: PART-I Release. PART-II will release soon
许可
This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)
- 1. 【译】在ASP.NET中创建PDF-iTextSharp起步
- 2. 【转】使用iTextSharp在Asp.Net中操做PDF 实战 iTextSharp ITextSharp使用说明 C# 中使用iTextSharp组件建立简单PDF
- 3. 【译】在Asp.Net中操作PDF – iTextSharp-列表
- 4. 【译】在Asp.Net中操做PDF – iTextSharp - 使用表格
- 5. [翻译] 使用 Python 建立你本身的 Shell：Part I
- 6. VS2008 使用itextsharp生成PDF
- 7. 在Xcode6中使用IBDesignable建立自定义控件(翻译)
- 8. Qt使用poppler读取pdf
- 9. ITextSharp生成PDF
- 10. C#使用iTextSharp给PDF添加水印
- 更多相关文章...
- • 在Spring中使用Redis - Redis教程
- • 在Java程序中使用Redis - Redis教程
- • TiDB 在摩拜单车在线数据业务的应用和实践
- • Composer 安装与使用
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. 【译】在ASP.NET中创建PDF-iTextSharp起步
- 2. 【转】使用iTextSharp在Asp.Net中操做PDF 实战 iTextSharp ITextSharp使用说明 C# 中使用iTextSharp组件建立简单PDF
- 3. 【译】在Asp.Net中操作PDF – iTextSharp-列表
- 4. 【译】在Asp.Net中操做PDF – iTextSharp - 使用表格
- 5. [翻译] 使用 Python 建立你本身的 Shell：Part I
- 6. VS2008 使用itextsharp生成PDF
- 7. 在Xcode6中使用IBDesignable建立自定义控件(翻译)
- 8. Qt使用poppler读取pdf
- 9. ITextSharp生成PDF
- 10. C#使用iTextSharp给PDF添加水印