ABCpdf.NET使用介绍

罗学林

2023-12-01

最新做一个项目需要生成pdf文档以供打印，研究决定使用abcpdf这款组件，先针对其使用方法做一个简单的总结介绍以给有需要的朋友做参考。

一、 ABCpdf.NET简单介绍
ABCpdf.NET是一个能够很方便生成pdf的.net组件，能够运行在以下操作系统中：Windows 2000, Windows XP, Windows Server 2003, Windows Vista, and Windows Server 2008.官方建议运行环境安装IE6或者以上版本。对应不同的系统，它有32位和64位的版本，使用时注意版本的选用。
ABCpdf的功能比较多，比如可以读word、excel等文件，可以保存pdf、xps、swf等格式文件。本文主要介绍其生成pdf的方法。使用时，需要ABCpdf.DLL和ABCpdfCE7.DLL支持。其中ABCpdf.DLL（.net调用接口）需要引用到项目中，ABCpdfCE7.DLL（核心驱动）放在ABCpdf.DLL的同一目录下即可。
ABCpdf的坐标系采用Adobe PDF标准坐标系，原点在屏幕的左下角，采用72DPI（我们用的通常是96DPI，在计算大小时注意转换，网页面上的96px相当于ABCpdf里面72px）

二、入门，生成第一个pdf文件
这一节将通过实例来展示如何用ABCpdf.NET生成pdf文件。在使用前需要引入ABCpdf.DLL，在代码中引用名空间：using WebSupergoo.ABCpdf7;通常情况下只需要引入这个名空间就可以了。
Code：
    private void GeneratePdfTest1()
    {
         using (Doc theDoc = new Doc())
            {
                theDoc.Rect.Inset(24, 48);
                //Rect默认是文档整个页面大小, 这里的Inset表示将Rect左右留出24的空白,上下留出48的空白

                theDoc.Color.String = "32,48,117";
                theDoc.FrameRect();//为当前rect添加边框
                theDoc.MediaBox.String = "0 0 590 840";//设置添加新页面时，页面的大小
                theDoc.Rect.String = "14 14 576 770";//当前输出区间
                theDoc.Color.String = "192,48,117";
                theDoc.FrameRect();
                theDoc.FontSize = 12;
                theDoc.AddText("Hello World");
                theDoc.Font = theDoc.AddFont("宋体", "ChineseS");
                theDoc.FontSize = 16;
                theDoc.Flatten();//合并pdf各个layer，减少pdf大小
                theDoc.Save(Server.MapPath("simple.pdf"));
                theDoc.Clear();
            }
        }
上面的代码可以简单的生成一个pdf文件。

三、进阶，控制生成的pdf
上面的代码只是简单的生成了一个pdf，很多细节问题都没有说明，现在将介绍如何控制生成的pdf和介绍一些有用的方法。比如页面的大小、字体、添加的内容位置等。
WebSupergoo.ABCpdf7.Doc类有很多属性和方法可以利用，这里我们就要用到：

1. SetInfo方法
virtual void SetInfo(int id, string type, string value)
用来获取或者改变pdf页面各对象的外观情况，id通过getinfo方法可以获取。
e.g.默认的pdf页面大小是a4页面大小，可以用这个方法来改变当前页面的大小。
theDoc.SetInfo(theDoc.Page, "/MediaBox:Rect", "0 0 200 300");

2. Rect属性
这是一个很重要的属性，abcpdf里面生成pdf的基本思路就是先确定一个rect再向该rect里里面添加内容，所有的pdf对象都依赖rect，用rect来定位的。
e.g.在指定位置添加文字。
theDoc.Rect.String = "14 14 576 770";
theDoc.AddText("Hello World");
当然，可以在添加文字前设置字体和颜色等信息：
theDoc.Font = theDoc.AddFont("宋体", "ChineseS");
theDoc.FontSize = 12;
theDoc.Color.String = "192,48,117";

3. MediaBox属性
设置MediaBox属性只会影响后面添加的页面大小，后面添加的页面大小将会是MediaBox设置的大小。它不会影响已存在的页面大小。改变已存在页面大小用setinfo方法。

4. Layer属性
获取或设置当前层，和html的层是一样的，前面的层会覆盖后面的层。默认的Layer为1，在最前面。

AddHtml添加html代码（将会被解析，但此方法不支持css）支持以下html标记：
<Head>
<Body>
<BR>
<P>
<H1> to <H6>
<List>
<UL>
<OL>
<LI>
<A>
<B>
<I>
<U>
<Strike>
<Sup>
<Sub>
<Font>
<StyleRun>
<BlockQuote>
<Pre>
e.g.Code:
Doc theDoc = new Doc();
theDoc.FontSize = 72;
theDoc.AddHtml("<b>Gallia</b> est omnis divisa in partes tres, quarum unam incolunt <b>Belgae</b>, aliam <b>Aquitani</b>, tertiam qui ipsorum lingua <b>Celtae</b>, nostra <b>Galli</b> appellantur.");
theDoc.Save(Server.MapPath("docaddhtml.pdf"));
theDoc.Clear();

5. AddImageHtml方法
virtual int AddImageHtml(string html)
virtual int AddImageHtml(string html, bool paged, int width, bool disableCache)
html 需要添加的html
paged 是否分页，true启用分页
width 页面的宽度（浏览器解析html时浏览器的宽度）
disableCache 是否忽略缓存，true不启用缓存，false启用缓存，缓存时间5分钟
return 返回添加的html对象id
说明：这个方法和AddImageUrl基本上是一样的，只不过这个直接用的html，AddImageUrl用的是url地址。这个方法将用传入的html生成一个临时文件，然后解析该临时文件来为pdf添加相关内容。这个是一个很简单的方法，它不提供任何性能上的提升。如果是在asp.net中使用，需要IIS拥有对临时文件夹的完全访问权限，否则将会出现错误。如果html内含有外部的样式和图片，则需要用绝对地址，因为传入的html没有具体的地址，将会无法解析其包含的相对地址。如果必须用相对地址，请用AddImageUrl方法。
e.g.Code:
Doc theDoc = new Doc();
using (StreamReader sReader = new StreamReader(Server.MapPath("s.html")))
{
theDoc.AddImageHtml(sReader.ReadToEnd(),true,760,true);
}

6. AddImageUrl方法
virtual int AddImageUrl(string url)
virtual int AddImageUrl(string url, bool paged, int width, bool disableCache)
参数说明同上，只不过是将html换成了url。
说明：通过这个方法可以很方便的将一个web page添加到pdf文件，其解析web page用的是ie的内核（版本估计和机器上安装的版本相关，有兴趣可以利用css测试一下）。值得注意的一个问题是pdf的dpi是72，通常html的dpi是96，所以如果要pdf上显示的和浏览器上看到的一样大，那么在设置rect大小（会填满所设置的rect）的时候需要用width参数乘以72/96。
e.g.Code：
Doc theDoc = new Doc();
theDoc.AddImageUrl("http://www.google.com/");
theDoc.Save(Server.MapPath("htmlimport.pdf"));
theDoc.Clear();

四、进阶，如何分页
在利用html转pdf的时候，通常都会遇到的问题。abcpdf会进行智能的分页，而分页的实现也只需要几行代码。
int theID = theDoc.AddImageUrl("http://localhost:1141/WebSitePDF/000001.OF.html", true, 760, true);
//以下实现多页效果
while (true)
{
     theDoc.FrameRect();//画Rect的边框
     if (!theDoc.Chainable(theID))
        break;
     theDoc.Page = theDoc.AddPage();
     theID = theDoc.AddImageToChain(theID);
}
如果需要在分页时不对模块进行截断，请为相应模块添加打印样式“page-break-inside: avoid”如果需要在指定位置进行强制分页，请添加：“<div style="page-break-before:always"> </div>”其中“ ”是必须要的。经过我的实验此强制分页标记并不是任何时候都分页的，用之前注意针对指定的html代码进行测试。推荐用自动分页+保证模块完整性样式。
对于需要设置页眉和页脚的，也很简便，只要将页面分成三个rect（页眉，页脚，中间内容），分页的时候将内容添加到中间的rect，分页完毕后再分别补充页面，页脚。
e.g.Code：
theDoc.Rect.String = "14 35 576 803";
int theID = theDoc.AddImageUrl(url, true, 760, true);
//以下实现多页效果
while (true)
{
if (!theDoc.Chainable(theID))
   break;
theDoc.Page = theDoc.AddPage();
theID = theDoc.AddImageToChain(theID);
}

for (int i = 1; i <= theDoc.PageCount; i++)
{
theDoc.PageNumber = i;
表头
theDoc.Rect.String = "14 803 576 835";
theDoc.AddImageUrl(urlTop, false, 760, true);
表尾
theDoc.Rect.String = "14 35 576 5";
theDoc.AddImageUrl(urlBottom, false, 760, true);
}

五、运行js，js支持
abcpdf支持html页面脚本JavaScript，这让我们利用html生成pdf时多了一个利器，可以通过js改变html，再生成pdf。如何执行页面上的js呢？下面将介绍几个相关的属性。注意这个受运行机器浏览器安全设置限制，如果浏览器安全级别很高或者限制了js的运行，在调用js的时候将会报错：Unable to apply JScript
Windows error 5. Access is denied.

1. theDoc.HtmlOptions.UseScript
是否启用脚本，默认为false不启用

2. theDoc.HtmlOptions.OnLoadScript
当启用脚本时，页面载入后执行的脚本，可以是一段js代码，也可以是html页面包含函数方法

3. theDoc.HtmlOptions.HostWebBrowser
是否启用WebBrowser，默认为false不启用。只有在启用了WebBrowser后，left, top, width, height, offsetLeft, offsetTop, offsetWidth, offsetHeight, clientLeft, clientTop, clientWidth, clientHeight, pixelLeft, pixelTop, pixelWidth, pixelHeight, posLeft, posTop, posWidth, and posHeight这些dom方法才可用，否则都是0。在启用WebBrowser后，还可以用用xml，xslt。

e.g.Code：
theDoc.HtmlOptions.UseScript = true;
theDoc.HtmlOptions.HostWebBrowser = true;
theDoc.HtmlOptions.OnLoadScript ="var divs=document.getElementById('content').childNodes;if(divs[0].scrollHeight<divs[1].scrollHeight)divs[0].style.height=divs[1].scrollHeight;";

六、关于程序发布注册
对于发布程序，需要在创建doc对象前注册一些该组件的key，如下：
XSettings.InstallRedistributionLicense（" 注册码"）;
Doc doc = new Doc();
Response.Write("License: " + doc.License + "<br>");
或者
Doc theDoc = new Doc();
// here we use a trial license key as copied from the PDFSettings application
theDoc.SetInfo(0, "License", "cd9b5c07db69df2bf57c0a04d9bca58b10c44889c9fb197984e592f49addfce5ec5fe85d7b9205bc");
Response.Write(theDoc.GetInfo(0, "License"));
在程序引入的dll版本要和打包的版本一致，否则会出现找不到xx版本dll的错误，编译时将dll的版本号也包含进去了，大概是因为该dll是强命名的原因。

ABCpdf.NET使用介绍

相关阅读

相关文章

相关问答

相关文档