開源免費且穩定實用的.NET PDF打印組件itextSharp（.NET組件介紹之八）
版權聲明：本文為原創文章，版權牛站新聞所有
轉載請註明http://www.niuzhan.com/Bago/
在這個.NET組件的介紹系列中，受到了很多園友的支持，一些園友（如：數據之巔、 [秦時明月]等等這些大神 ）也給我提出了對應的建議，我正在努力去改正，有不足之處還望大家多多包涵。在傳播一些簡單的知識的同時，我自己也得到了一些提升，這個是我感覺到的最大的益處。知識需要傳播，在傳播的過程中去讓學習的人去提升，在交流中的過程中去讓思考的人去展望，我希望我也能在這個傳播的過程中出一份力。由於自身能力有限，在編寫博文時出現的錯誤和一些不到位的講解，還望大家多多見諒。
上面賣完情懷，下面就該切入正題了。
提到打印，恐怕對於很多人都不會陌生，無論是開發者，還是非計算機專業的人員都會接觸到打印。對於項目開發中使用到打印的地方會非常多，在.NET項目中，選擇打印的方式比較多，例如原始的IE網頁打印、水晶報表、JS插件實現打印、導出文檔打印，以及今天提到的使用itextSharp組件實現PDF打印等等。
在.NET中實現PDF打印的組件比較多，例如PDFsharp、Report.NET、sharpPDF、itextSharp等等，今天主要簡單的介紹itextSharp組件。
一.itextSharp組件概述：
1.iText的是PDF庫，它允許你創建，調整，檢查和維護的可移植文檔格式文件（PDF）：
(1).基於從XML文件或數據庫中的數據生成文件和報告。
(2).創建地圖和書籍，利用眾多的互動在PDF可用的功能。
(3).添加書簽，頁碼，水印等功能，以現有的PDF文件。
(4).從現有PDF文件拆分或連接頁面；填寫交互式表單。
(5).即成動態生成或操縱PDF文檔到Web瀏覽器。 iText所使用的的Java，.NET，Android和GAE開發人員加強與PDF功能的應用程序。iTextSharp的是.NET端口。
2.itextSharp的一些特征：
(1).PDF生成。 (2).PDF操作（沖壓水印，合並/拆分PDF文件，...）。 (3).PDF表單填寫。 (4).XML功能。 (5).數字簽名。
以上是對itextSharp組件的一些特性的簡單介紹，如果需要更加深入的了解itextSharp組件的相關信息，可以細致的查看API文檔和itextSharp產品介紹。https://sourceforge.net/projects/itextsharp/#overview。
二.itextSharp組件核心類和方法：
談到打印，在我們的項目中需要首先考慮的是我們需要打印的東西是什麽。在大腦裏面應該首先有一個文檔的概念，在我們編程的過程中，“文檔”這個詞無處不在，這個可以是一個寬泛的概念，也可以是一個狹窄的概念，寬泛的“文檔”是指容器，用以存放一些元素；狹窄的“文檔”是指實際的文件類型。
對於打印的“文檔”，具體看一下寬泛的概念，文檔包含元素和節點等等。在組織打印的時候，我們需要創建文檔，寫入元素和節點等信息，最後組合成為我們需要打印的內容。itextSharp組件可以插入段落、表格、圖片等等信息，可以很方便的完成我們需要完成的功能。
Paragraph：報表中的文本；Image：報表中的圖片；PdfPTable：表格；PdfPCell：單元格。
1.Document類Open()方法：打開文檔對象。
01
public virtual void Open()
02
{
03
if (!this.close)
04
{
05
this.open = true;
06
}
07
foreach (IDocListener listener in this.listeners)
08
{
09
listener.SetPageSize(this.pageSize);
10
listener.SetMargins(this.marginLeft, this.marginRight, this.marginTop, this.marginBottom);
11
listener.Open();
12
}
13
}
以上的代碼可以看到，我們在打開文檔的時候，會設置文檔大小，文檔頁邊距等信息。
2.Paragraph類Add()方法：向段落添加元素。
01
public override bool Add(IElement o)
02
{
03
if (o is List)
04
{
05
List element = (List) o;
06
element.IndentationLeft += this.indentationLeft;
07
element.IndentationRight = this.indentationRight;
08
base.Add(element);
09
return true;
10
}
11
if (o is Image)
12
{
13
base.AddSpecial((Image) o);
14
return true;
15
}
16
if (o is Paragraph)
17
{
18
base.Add(o);
19
IList<Chunk> chunks = this.Chunks;
20
if (chunks.Count > 0)
21
{
22
Chunk chunk = chunks[chunks.Count - 1];
23
base.Add(new Chunk("\n", chunk.Font));
24
}
25
else
26
{
27
base.Add(Chunk.NEWLINE);
28
}
29
return true;
30
}
31
base.Add(o);
32
return true;
33
}
01
public interface IElement
02
{
03
// Methods
04
bool IsContent();
05
bool IsNestable();
06
bool Process(IElementListener listener);
07
string ToString();
08
09
// Properties
10
IList<Chunk> Chunks { get; }
11
int Type { get; }
12
}
以上的add()方法是向段落添加元素，我們可以看到參數是個接口“IElement”，我們接下來看一下這個接口，接口主要元素是塊。我們看到在向段落添加元素時，可以添加List，Image，Paragraph，Chunk。
3.Image.GetInstance()獲取圖片實例。
01
public static Image GetInstance(Image image)
02
{
03
if (image == null)
04
{
05
return null;
06
}
07
return (Image) image.GetType().GetConstructor(BindingFlags.Public | BindingFlags.Instance, null, new Type[] { typeof(Image) }, null).Invoke(new object[] { image });
08
}
09
10
11
public static Image GetInstance(byte[] imgb)
12
{
13
int num = imgb[0];
14
int num2 = imgb[1];
15
int num3 = imgb[2];
16
int num4 = imgb[3];
17
if (((num == 0x47) && (num2 == 0x49)) && (num3 == 70))
18
{
19
GifImage image = new GifImage(imgb);
20
return image.GetImage(1);
21
}
22
if ((num == 0xff) && (num2 == 0xd8))
23
{
24
return new Jpeg(imgb);
25
}
26
if (((num == 0) && (num2 == 0)) && ((num3 == 0) && (num4 == 12)))
27
{
28
return new Jpeg2000(imgb);
29
}
30
if (((num == 0xff) && (num2 == 0x4f)) && ((num3 == 0xff) && (num4 == 0x51)))
31
{
32
return new Jpeg2000(imgb);
33
}
34
if (((num == PngImage.PNGID[0]) && (num2 == PngImage.PNGID[1])) && ((num3 == PngImage.PNGID[2]) && (num4 == PngImage.PNGID[3])))
35
{
36
return PngImage.GetImage(imgb);
37
}
38
if ((num == 0xd7) && (num2 == 0xcd))
39
{
40
return new ImgWMF(imgb);
41
}
42
if ((num == 0x42) && (num2 == 0x4d))
43
{
44
return BmpImage.GetImage(imgb);
45
}
46
if ((((num == 0x4d) && (num2 == 0x4d)) && ((num3 == 0) && (num4 == 0x2a))) || (((num == 0x49) && (num2 == 0x49)) && ((num3 == 0x2a) && (num4 == 0))))
47
{
48
RandomAccessFileOrArray s = null;
49
try
50
{
51
s = new RandomAccessFileOrArray(imgb);
52
Image tiffImage = TiffImage.GetTiffImage(s, 1);
53
if (tiffImage.OriginalData == null)
54
{
55
tiffImage.OriginalData = imgb;
56
}
57
return tiffImage;
58
}
59
finally
60
{
61
if (s != null)
62
{
63
s.Close();
64
}
65
}
66
}
67
throw new IOException(MessageLocalization.GetComposedMessage("the.byte.array.is.not.a.recognized.imageformat"));
68
}
該方法根據參數獲取圖片實例的方式比較多，例如：Image，PdfTemplate，PRIndirectReference，byte[]，Stream，string ，Uri等等，以上給出了根據Image和byte[]獲取ItextSharp的image實例。
4.Image的ScaleAbsolute()：設置圖片信息。
1
public void ScaleAbsolute(float newWidth, float newHeight)
2
{
3
this.plainWidth = newWidth;
4
this.plainHeight = newHeight;
5
float[] matrix = this.Matrix;
6
this.scaledWidth = matrix[6] - matrix[4];
7
this.scaledHeight = matrix[7] - matrix[5];
8
this.WidthPercentage = 0f;
9
}
以上代碼可以看出，設置圖片的信息主要包括高度、寬度、排列等信息。
5.Anchor類的Process()方法：重寫鏈接的處理方法。
01
public override bool Process(IElementListener listener)
02
{
03
try
04
{
05
bool flag = (this.reference != null) && this.reference.StartsWith("#");
06
bool flag2 = true;
07
foreach (Chunk chunk in this.Chunks)
08
{
09
if (((this.name != null) && flag2) && !chunk.IsEmpty())
10
{
11
chunk.SetLocalDestination(this.name);
12
flag2 = false;
13
}
14
if (flag)
15
{
16
chunk.SetLocalGoto(this.reference.Substring(1));
17
}
18
else if (this.reference != null)
19
{
20
chunk.SetAnchor(this.reference);
21
}
22
listener.Add(chunk);
23
}
24
return true;
25
}
26
catch (DocumentException)
27
{
28
return false;
29
}
30
}
以上方法可以看到，該方法是在本類中被重寫，用以處理鏈接的相關信息。
6.PageSize：設置紙張的類型。
01
public class PageSize
02
{
03
// Fields
04
public static readonly Rectangle _11X17;
05
public static readonly Rectangle A0;
06
public static readonly Rectangle A1;
07
public static readonly Rectangle A10;
08
public static readonly Rectangle A2;
09
public static readonly Rectangle A3;
10
public static readonly Rectangle A4;
11
public static readonly Rectangle A4_LANDSCAPE;
12
public static readonly Rectangle A5;
13
public static readonly Rectangle A6;
14
public static readonly Rectangle A7;
15
public static readonly Rectangle A8;
16
public static readonly Rectangle A9;
17
public static readonly Rectangle ARCH_A;
18
public static readonly Rectangle ARCH_B;
19
public static readonly Rectangle ARCH_C;
20
public static readonly Rectangle ARCH_D;
21
public static readonly Rectangle ARCH_E;
22
public static readonly Rectangle B0;
23
public static readonly Rectangle B1;
24
public static readonly Rectangle B10;
25
public static readonly Rectangle B2;
26
public static readonly Rectangle B3;
27
public static readonly Rectangle B4;
28
public static readonly Rectangle B5;
29
public static readonly Rectangle B6;
30
public static readonly Rectangle B7;
31
public static readonly Rectangle B8;
32
public static readonly Rectangle B9;
33
public static readonly Rectangle CROWN_OCTAVO;
34
public static readonly Rectangle CROWN_QUARTO;
35
public static readonly Rectangle DEMY_OCTAVO;
36
public static readonly Rectangle DEMY_QUARTO;
37
public static readonly Rectangle EXECUTIVE;
38
public static readonly Rectangle FLSA;
39
public static readonly Rectangle FLSE;
40
public static readonly Rectangle HALFLETTER;
41
public static readonly Rectangle ID_1;
42
public static readonly Rectangle ID_2;
43
public static readonly Rectangle ID_3;
44
public static readonly Rectangle LARGE_CROWN_OCTAVO;
45
public static readonly Rectangle LARGE_CROWN_QUARTO;
46
public static readonly Rectangle LEDGER;
47
public static readonly Rectangle LEGAL;
48
public static readonly Rectangle LEGAL_LANDSCAPE;
49
public static readonly Rectangle LETTER;
50
public static readonly Rectangle LETTER_LANDSCAPE;
51
public static readonly Rectangle NOTE;
52
public static readonly Rectangle PENGUIN_LARGE_PAPERBACK;
53
public static readonly Rectangle PENGUIN_SMALL_PAPERBACK;
54
public static readonly Rectangle POSTCARD;
55
public static readonly Rectangle ROYAL_OCTAVO;
56
public static readonly Rectangle ROYAL_QUARTO;
57
public static readonly Rectangle SMALL_PAPERBACK;
58
public static readonly Rectangle TABLOID;
59
60
// Methods
61
static PageSize();
62
public PageSize();
63
public static Rectangle GetRectangle(string name);
64
}
以上的類中，我們可以看到我們可以設置需要打印的紙張類型，根據實際情況可以選擇。在最下面我們看到了兩種方法，一個是PageSize()設置紙張大小，一個是GetRectangle()繪制矩形。
以上是對itextSharp組件的一些類和方法的簡單介紹，對於表格，單元格等等類的介紹就不再繼續，有興趣的可以自己查看源代碼信息。
三.itextSharp組件實例：
上面介紹了itextSharp組件的背景、特性，以及組件的核心類和方法，在這裏給出一個簡單的itextSharp組件操作的實例，這個實例只是一個簡單的介紹。
001
/// <summary>
002
/// 字體
003
/// </summary>
004
private Font _font;
005
006
/// <summary>
007
/// 文檔大小
008
/// </summary>
009
private Rectangle _rect;
010
011
/// <summary>
012
/// 文檔對象
013
/// </summary>
014
private readonly Document _document;
015
016
/// <summary>
017
/// 基礎字體
018
/// </summary>
019
private BaseFont _basefont;
020
021
/// <summary>
022
/// 構造函數
023
/// </summary>
024
public PDFOperation()
025
{
026
_rect = PageSize.A4;
027
_document = new Document(_rect);
028
}
029
030
/// <summary>
031
/// 構造函數
032
/// </summary>
033
/// <param name="type">頁面大小(如"A4")</param>
034
public PDFOperation(string type)
035
{
036
if (string.IsNullOrEmpty(type))
037
{
038
throw new ArgumentNullException(type);
039
}
040
SetPageSize(type);
041
_document = new Document(_rect);
042
}
043
044
/// <summary>
045
/// 構造函數
046
/// </summary>
047
/// <param name="type">頁面大小(如"A4")</param>
048
/// <param name="marginLeft">內容距左邊框距離</param>
049
/// <param name="marginRight">內容距右邊框距離</param>
050
/// <param name="marginTop">內容距上邊框距離</param>
051
/// <param name="marginBottom">內容距下邊框距離</param>
052
public PDFOperation(string type, float marginLeft, float marginRight, float marginTop, float marginBottom)
053
{
054
if (string.IsNullOrEmpty(type))
055
{
056
throw new ArgumentNullException(type);
057
}
058
SetPageSize(type);
059
_document = new Document(_rect, marginLeft, marginRight, marginTop, marginBottom);
060
}
061
062
063
/// <summary>
064
/// 設置字體
065
/// </summary>
066
public void SetBaseFont(string path)
067
{
068
if (string.IsNullOrEmpty(path))
069
{
070
throw new ArgumentNullException(path);
071
}
072
_basefont = BaseFont.CreateFont(path, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
073
}
074
075
/// <summary>
076
/// 設置字體
077
/// </summary>
078
/// <param name="size">字體大小</param>
079
public void SetFont(float size)
080
{
081
_font = new Font(_basefont, size);
082
}
083
084
/// <summary>
085
/// 設置頁面大小
086
/// </summary>
087
/// <param name="type">頁面大小(如"A4")</param>
088
public void SetPageSize(string type)
089
{
090
if (string.IsNullOrEmpty(type))
091
{
092
throw new ArgumentNullException(type);
093
}
094
switch (type.Trim())
095
{
096
//枚舉需要的文檔紙張大小
097
case "A3":
098
_rect = PageSize.A3;
099
break;
100
case "A4":
101
_rect = PageSize.A4;
102
break;
103
case "A8":
104
_rect = PageSize.A8;
105
break;
106
}
107
}
108
109
/// <summary>
110
/// 實例化文檔
111
/// </summary>
112
/// <param name="os">文檔相關信息（如路徑，打開方式等）</param>
113
public void GetInstance(Stream os)
114
{
115
if (os == null)
116
{
117
throw new ArgumentNullException("os");
118
}
119
PdfWriter.GetInstance(_document, os);
120
}
121
122
/// <summary>
123
/// 打開文檔對象
124
/// </summary>
125
/// <param name="os">文檔相關信息（如路徑，打開方式等）</param>
126
public void Open(Stream os)
127
{
128
if (os == null)
129
{
130
throw new ArgumentNullException("os");
131
}
132
GetInstance(os);
133
_document.Open();
134
}
135
136
/// <summary>
137
/// 關閉打開的文檔
138
/// </summary>
139
public void Close()
140
{
141
_document.Close();
142
}
143
144
/// <summary>
145
/// 添加段落
146
/// </summary>
147
/// <param name="content">內容</param>
148
/// <param name="fontsize">字體大小</param>
149
public void AddParagraph(string content, float fontsize)
150
{
151
SetFont(fontsize);
152
var pra = new Paragraph(content, _font);
153
_document.Add(pra);
154
}
155
156
/// <summary>
157
/// 添加段落
158
/// </summary>
159
/// <param name="content">內容</param>
160
/// <param name="fontsize">字體大小</param>
161
/// <param name="alignment">對齊方式（1為居中，0為居左，2為居右）</param>
162
/// <param name="spacingAfter">段後空行數（0為默認值）</param>
163
/// <param name="spacingBefore">段前空行數（0為默認值）</param>
164
/// <param name="multipliedLeading">行間距（0為默認值）</param>
165
public void AddParagraph(string content, float fontsize, int alignment, float spacingAfter, float spacingBefore, float multipliedLeading)
166
{
167
SetFont(fontsize);
168
var pra = new Paragraph(content, _font)
169
{
170
Alignment = alignment
171
};
172
if (spacingAfter != 0)
173
{
174
pra.SpacingAfter = spacingAfter;
175
}
176
if (spacingBefore != 0)
177
{
178
pra.SpacingBefore = spacingBefore;
179
}
180
if (multipliedLeading != 0)
181
{
182
pra.MultipliedLeading = multipliedLeading;
183
}
184
_document.Add(pra);
185
}
186
187
/// <summary>
188
/// 添加圖片
189
/// </summary>
190
/// <param name="path">圖片路徑</param>
191
/// <param name="alignment">對齊方式（1為居中，0為居左，2為居右）</param>
192
/// <param name="newWidth">圖片寬（0為默認值，如果寬度大於頁寬將按比率縮放）</param>
193
/// <param name="newHeight">圖片高</param>
194
public void AddImage(string path, int alignment, float newWidth, float newHeight)
195
{
196
if (string.IsNullOrEmpty(path))
197
{
198
throw new ArgumentNullException(path);
199
}
200
var img = Image.GetInstance(path);
201
img.Alignment = alignment;
202
// ReSharper disable once CompareOfFloatsByEqualityOperator
203
if (newWidth != 0)
204
{
205
img.ScaleAbsolute(newWidth, newHeight);
206
}
207
else
208
{
209
if (img.Width > PageSize.A4.Width)
210
{
211
img.ScaleAbsolute(_rect.Width, img.Width * img.Height / _rect.Height);
212
}
213
}
214
_document.Add(img);
215
}
216
217
/// <summary>
218
/// 添加鏈接
219
/// </summary>
220
/// <param name="content">鏈接文字</param>
221
/// <param name="fontSize">字體大小</param>
222
/// <param name="reference">鏈接地址</param>
223
public void AddAnchorReference(string content, float fontSize, string reference)
224
{
225
if (string.IsNullOrEmpty(content))
226
{
227
throw new ArgumentNullException(content);
228
}
229
SetFont(fontSize);
230
var auc = new Anchor(content, _font)
231
{
232
Reference = reference
233
};
234
_document.Add(auc);
235
}
236
237
/// <summary>
238
/// 添加鏈接點
239
/// </summary>
240
/// <param name="content">鏈接文字</param>
241
/// <param name="fontSize">字體大小</param>
242
/// <param name="name">鏈接點名</param>
243
public void AddAnchorName(string content, float fontSize, string name)
244
{
245
if (string.IsNullOrEmpty(content))
246
{
247
throw new ArgumentNullException(content);
248
}
249
SetFont(fontSize);
250
var auc = new Anchor(content, _font)
251
{
252
Name = name
253
};
254
_document.Add(auc);
255
}
以上的實例比較的簡單，主要是用作簡單介紹組件的用法。如果需要將組件設計的更加通用，我們可以將組件的相關類和方法重寫，並且可以開發一套cs或者bs程序，實現組件的圖形化操作，圖形化操作生成文件模板。文件模板可以將相關信息序列化（json或者二進制），在項目中直接加載模型，並將數據綁定在模板中，實現pdf打印的動態配置。
這個程序的開發難度一般，如果有興趣的可以自行開發一套工具，可以更好的實現我們的項目pdf打印功能。
四.總結：
上面介紹了itextSharp組件的相關信息，在這個系列的組件介紹中，對於組件的介紹都是比較的簡單，旨在向大家介紹這個組件，在實際的開發中，我們可以根據實際情況自行選擇相應的組件，組件沒有絕對的好壞，只有合適的場景
開源免費且穩定實用的.NET PDF打印組件itextSharp（.NET組件介紹之八）