在Winform分页控件中集成导出PDF文档的功能

巧智无求

当前的Winform分页控件中，当前导出的数据一般使用Excel来处理，Excel的文档可以用于后期的数据展示或者批量导入做准备，因此是比较好的输入输出格式。但是有框架的使用客户希望分页控件能够直接导出PDF，虽然Excel也可以直接转换为PDF，不过直接导出PDF的处理肯定更加方便直观。因此整理了一下分页控件导出PDF的处理过程，分享一下。
1、PDF的导出插件

使用PDF导出的插件有很多，如Aspose.PDF、Spire.PDF、PdfSharp、iTextSharp等等很多，有些是收费的，有些是开源免费的，我们这里使用iTextSharp开源组件进行PDF的导出处理操作。

在测试的时候，我们可以对一个表格内容进行数据的导出，以便验证效果，然后在考虑整合到分页控件的内部中使用，如下测试界面所示。

大概的效果如下所示。

 如果需要，我们可以进一步定义页眉和页脚，增加一些特殊的信息等等。
我们可以测试导出列表中的DataTable数据源，如下所示。

1.         private void btnExportPdf_Click(object sender, EventArgs e)
2.         {
3.             //带参数处理
4.             bool isLandscape = true;//是否为横向打印，默认为true
5.             bool includeHeader = true;//是否每页包含表头信息
6.             int headerAlignment = Element.ALIGN_CENTER;//头部的对其方式，默认为居中对齐
7.             float headerFontSize = 9f;//头部字体大小
8.             float rowFontSize = 9f;//行记录字体大小
9.             float? headerFixHeight = null;//头部的固定高度，否则为自适应
10.             <strong>TextSharpHelper</strong><strong>.ExportPdf</strong>(isLandscape, includeHeader, headerAlignment, headerFontSize, rowFontSize, headerFixHeight);
11.         }

复制代码

2、导出PDF的逻辑处理

上面的操作，对辅助类TextSharpHelper.ExportPdf 的操作进行封装了，我们可以看到，方法留出了几个特殊的配置信息，可供我们进行调整格式。
一般使用列表的输出为横向较为美观，字体比正常窗体显示的字体小一点，并可以设置是否每页PDF包含表头信息等等。
辅助类的全部代码如下所示：

1.     /// <summary>
2.     /// 基于iTextSharp.text.pdf对PDF的导出处理
3.     /// </summary>
4.     public static class TextSharpHelper
5.     {
6.         /// <summary>
7.         /// datatable转PDF方法
8.         /// </summary>
9.         /// <param name="data">dataTable数据</param>
10.         /// <param name="pdfFile">PDF文件保存的路径</param>
11.         /// <param name="isLandscape">是否为横向打印，默认为true</param>
12.         /// <param name="includeHeader">是否每页包含表头信息</param>
13.         /// <param name="headerAlignment">头部的对其方式，默认为居中对齐</param>
14.         /// <param name="headerFontSize">头部字体大小</param>
15.         /// <param name="rowFontSize">行记录字体大小</param>
16.         /// <param name="headerFixHeight">头部的固定高度，否则为自适应</param>
17.         /// <returns></returns>
18.         public static bool ExportTableToPdf(DataTable data, string pdfFile, bool isLandscape = true, bool includeHeader = true, int headerAlignment = Element.ALIGN_CENTER, float headerFontSize = 9f, float rowFontSize = 9f, float? headerFixHeight = null)
19.         {
20.             //默认页面大小
21.             var document = new Document();
22.             var retangle = new iTextSharp.text.Rectangle(0, 0, isLandscape ? PageSize.A4.Height : PageSize.A4.Width, isLandscape ? PageSize.A4.Width : PageSize.A4.Height);
23.             document.SetPageSize(retangle);
24.             var writer = PdfWriter.GetInstance(document, new FileStream(pdfFile, FileMode.Create));
25.             document.Open();
27.             //设置字体
28.             var bfChinese = BaseFont.CreateFont("C:\\WINDOWS\\Fonts\\simsun.ttc,1", BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
29.             var fontHeader = new iTextSharp.text.Font(bfChinese, headerFontSize, iTextSharp.text.Font.BOLD, new BaseColor(0, 0, 0));
30.             var fontRow = new iTextSharp.text.Font(bfChinese, rowFontSize, iTextSharp.text.Font.NORMAL, new BaseColor(0, 0, 0));
32.             var table = new PdfPTable(data.Columns.Count);
33.             table.WidthPercentage = 100f; // percentage
34.             table.DefaultCell.Padding = 1;
35.             table.DefaultCell.BorderWidth = 1;
36.             table.DefaultCell.BorderWidth = 0.1f;
37.             table.DefaultCell.HorizontalAlignment = Element.ALIGN_LEFT;
38.             table.HeaderRows = includeHeader ? 1 : 0;
40.             //将datatable表头转换成PDFTable的表头
41.             var EventRowBackColor = Color.LightCyan;
42.             foreach (DataColumn dc in data.Columns)
43.             {
44.                 var caption = !string.IsNullOrEmpty(dc.Caption) ? dc.Caption : dc.ColumnName;
46.                 var cell = new PdfPCell();
47.                 if (headerFixHeight.HasValue)
48.                 {
49.                     cell.FixedHeight = headerFixHeight.Value;
50.                 }
51.                 cell.HorizontalAlignment = headerAlignment;
52.                 cell.VerticalAlignment = Element.ALIGN_MIDDLE;
53.                 cell.Phrase = new Phrase(caption, fontHeader);
54.                 table.AddCell(cell);
55.             }
57.             //插入数据
58.             for (int i = 0; i < data.Rows.Count; i++)
59.             {
60.                 var backgroudColor = new BaseColor((i % 2 == 0) ? Color.White : EventRowBackColor);
61.                 for (int j = 0; j < data.Columns.Count; j++)
62.                 {
63.                     var cell = new PdfPCell();
64.                     var text = data.Rows[i][j].ToString();
65.                     cell.BackgroundColor = backgroudColor;
66.                     cell.Phrase = new Phrase(text, fontRow);
67.                     table.AddCell(cell);
68.                 }
69.             }
70.             document.Add(table);
71.             document.Close();
72.             writer.Close();
73.             return true;
74.         }
75.     }

复制代码

上面根据方法的参数对字体，页面宽度高度、表格间隔颜色，表头等信息进行设置处理，然后使用插件进行输出PDF的内容即可，PDF内容的输出，有点类似DataTable的表格控制，单元格的信息可以独立控制。
为了不用重复的引用代码或者辅助类，我们可以整合到分页控件的列表中，在其中封装处理逻辑即可，这样所有列表都具有通用的导出PDF操作了，如下界面所示。

 
我们一般导出是通过事件进行处理的，因此，我们在底部的分页中定义一个触发的事件，如下所示。

1.     public delegate void <strong>ExportPdfEventHandler</strong>(object sender, EventArgs e);
2.     /// <summary>
3.     /// 分页工具条用户控件，仅提供分页信息显示及改变页码操作
4.     /// </summary>
5.     public class Pager : DevExpress.XtraEditors.XtraUserControl
6.     {
7.         /// <summary>
8.         /// 导出PDF的事件
9.         /// </summary>
10.         public event <strong>ExportPdfEventHandler</strong> ExportPdf;

复制代码

按钮单击的时候，触发事件的处理，如下代码所示。

1.         private void btnExportPdf_Click(object sender, EventArgs e)
2.         {
3.             if (ExportPdf != null)
4.             {
5.                 ExportPdf(sender, e);
6.             }
7.         }

复制代码

这样事件会传递到外面的容器组件中，对容器组件中的数据源进行导出处理即可。

1.         private void WinGridViewPager_Load(object sender, EventArgs e)
2.         {
3.             if (!this.DesignMode)
4.             {
5.                 this.pager.PageChanged += new PageChangedEventHandler(pager_PageChanged);
6.                 this.pager.ExportCurrent += new ExportCurrentEventHandler(pager_ExportCurrent);
7.                 this.pager.ExportAll += new ExportAllEventHandler(pager_ExportAll);
8.                 <strong>this.pager.ExportPdf += Pager_ExportPdf;</strong>

复制代码

对于列表的数据源，我们可以统一转换为DataTable格式，如下 分析数据源的格式进行转换。

1.             DataTable sourcetable = null;
2.             if (this.DataSource is DataView)
3.             {
4.                 DataView dv = (DataView)AllToExport;//默认导出显示内容
5.                 sourcetable = dv.ToTable();
6.             }
7.             else if (this.DataSource is DataTable)
8.             {
9.                 sourcetable = this.DataSource as DataTable;
10.             }
11.             else
12.             {
13.                 sourcetable = ReflectionUtil.CreateTable(this.DataSource);
14.             }

复制代码

而对于表格内容的中文注释，我们可以读取表格里面的头部信息作为PDF表头的中文信息，如下所示。

1.     var table = new DataTable();
2.     for (int i = 0; i < this.gridView1.Columns.Count; i++)
3.     {
4.         if (this.gridView1.Columns[i].Visible)
5.         {
6.             var column = new DataColumn(this.gridView1.Columns[i].FieldName, typeof(string));
7.             column.Caption = this.gridView1.Columns[i].Caption;
8.             table.Columns.Add(column);
9.         }
10.     }

复制代码

而每行的内容，可以逐一读取并写入其中即可。

1.     for (int i = 0; i < sourcetable.Rows.Count; i++)
2.     {
3.         var row = table.NewRow();
4.         for (int j = 0; j < table.Columns.Count; j++)
5.         {
6.             var columnName = table.Columns[j].ColumnName;
7.             var displayText = this.gridView1.GetRowCellDisplayText(i, columnName);
8.             row[columnName] = displayText ?? "";
9.         }
10.         table.Rows.Add(row);
11.     }

复制代码

最后调用辅助类进行导出PDF文档即可，导出后进行打开处理。

1.     var success =<strong> TextSharpHelper.ExportTableToPdf</strong>(table, pdfFile, isLandscape, includeHeader, headerAlignment, headerFontSize, rowFontSize, headerFixHeight);
2.     if (success)
3.     {
4.         Process.Start(pdfFile);
5.     }

复制代码

 
 导出PDF和前面的效果一样了。

 
 以上就是对PDF的导出处理的操作，希望能够给大家提供一定的帮助。
 

来源:https://www.cnblogs.com/wuhuacong/archive/2023/03/22/17243041.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！