详解开源免费且稳定实用的.NET PDF打印组件itextSharp（.NET组件介绍之八）

在这个.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产品介绍。。

二.itextsharp组件核心类和方法：

谈到打印，在我们的项目中需要首先考虑的是我们需要打印的东西是什么。在大脑里面应该首先有一个文档的概念，在我们编程的过程中，“文档”这个词无处不在，这个可以是一个宽泛的概念，也可以是一个狭窄的概念，宽泛的“文档”是指容器，用以存放一些元素；狭窄的“文档”是指实际的文件类型。

对于打印的“文档”，具体看一下宽泛的概念，文档包含元素和节点等等。在组织打印的时候，我们需要创建文档，写入元素和节点等信息，最后组合成为我们需要打印的内容。itextsharp组件可以插入段落、表格、图片等等信息，可以很方便的完成我们需要完成的功能。

paragraph：报表中的文本；image：报表中的图片；pdfptable：表格；pdfpcell：单元格。

1.document类open()方法：打开文档对象。

public virtual void open()
{
  if (!this.close)
  {
    this.open = true;
  }
  foreach (idoclistener listener in this.listeners)
  {
    listener.setpagesize(this.pagesize);
    listener.setmargins(this.marginleft, this.marginright, this.margintop, this.marginbottom);
    listener.open();
  }
}

以上的代码可以看到，我们在打开文档的时候，会设置文档大小，文档页边距等信息。

2.paragraph类add()方法：向段落添加元素。

public override bool add(ielement o)
{
  if (o is list)
  {
    list element = (list) o;
    element.indentationleft += this.indentationleft;
    element.indentationright = this.indentationright;
    base.add(element);
    return true;
  }
  if (o is image)
  {
    base.addspecial((image) o);
    return true;
  }
  if (o is paragraph)
  {
    base.add(o);
    ilist<chunk> chunks = this.chunks;
    if (chunks.count > 0)
    {
      chunk chunk = chunks[chunks.count - 1];
      base.add(new chunk("\n", chunk.font));
    }
    else
    {
      base.add(chunk.newline);
    }
    return true;
  }
  base.add(o);
  return true;
}

public interface ielement
{
  // methods
  bool iscontent();
  bool isnestable();
  bool process(ielementlistener listener);
  string tostring();

  // properties
  ilist<chunk> chunks { get; }
  int type { get; }
}

以上的add()方法是向段落添加元素，我们可以看到参数是个接口“ielement”，我们接下来看一下这个接口，接口主要元素是块。我们看到在向段落添加元素时，可以添加list，image，paragraph，chunk。

   3.image.getinstance()获取图片实例。

public static image getinstance(image image)
{
  if (image == null)
  {
    return null;
  }
  return (image) image.gettype().getconstructor(bindingflags.public | bindingflags.instance, null, new type[] { typeof(image) }, null).invoke(new object[] { image });
}

 
public static image getinstance(byte[] imgb)
{
  int num = imgb[0];
  int num2 = imgb[1];
  int num3 = imgb[2];
  int num4 = imgb[3];
  if (((num == 0x47) && (num2 == 0x49)) && (num3 == 70))
  {
    gifimage image = new gifimage(imgb);
    return image.getimage(1);
  }
  if ((num == 0xff) && (num2 == 0xd8))
  {
    return new jpeg(imgb);
  }
  if (((num == 0) && (num2 == 0)) && ((num3 == 0) && (num4 == 12)))
  {
    return new jpeg2000(imgb);
  }
  if (((num == 0xff) && (num2 == 0x4f)) && ((num3 == 0xff) && (num4 == 0x51)))
  {
    return new jpeg2000(imgb);
  }
  if (((num == pngimage.pngid[0]) && (num2 == pngimage.pngid[1])) && ((num3 == pngimage.pngid[2]) && (num4 == pngimage.pngid[3])))
  {
    return pngimage.getimage(imgb);
  }
  if ((num == 0xd7) && (num2 == 0xcd))
  {
    return new imgwmf(imgb);
  }
  if ((num == 0x42) && (num2 == 0x4d))
  {
    return bmpimage.getimage(imgb);
  }
  if ((((num == 0x4d) && (num2 == 0x4d)) && ((num3 == 0) && (num4 == 0x2a))) || (((num == 0x49) && (num2 == 0x49)) && ((num3 == 0x2a) && (num4 == 0))))
  {
    randomaccessfileorarray s = null;
    try
    {
      s = new randomaccessfileorarray(imgb);
      image tiffimage = tiffimage.gettiffimage(s, 1);
      if (tiffimage.originaldata == null)
      {
        tiffimage.originaldata = imgb;
      }
      return tiffimage;
    }
    finally
    {
      if (s != null)
      {
        s.close();
      }
    }
  }
  throw new ioexception(messagelocalization.getcomposedmessage("the.byte.array.is.not.a.recognized.imageformat"));
}

该方法根据参数获取图片实例的方式比较多，例如：image，pdftemplate，prindirectreference，byte[]，stream，string ，uri等等，以上给出了根据image和byte[]获取itextsharp的image实例。

 4.image的scaleabsolute()：设置图片信息。

public void scaleabsolute(float newwidth, float newheight)
{
  this.plainwidth = newwidth;
  this.plainheight = newheight;
  float[] matrix = this.matrix;
  this.scaledwidth = matrix[6] - matrix[4];
  this.scaledheight = matrix[7] - matrix[5];
  this.widthpercentage = 0f;
}

 以上代码可以看出，设置图片的信息主要包括高度、宽度、排列等信息。

 5.anchor类的process()方法：重写链接的处理方法。

public override bool process(ielementlistener listener)
{
  try
  {
    bool flag = (this.reference != null) && this.reference.startswith("#");
    bool flag2 = true;
    foreach (chunk chunk in this.chunks)
    {
      if (((this.name != null) && flag2) && !chunk.isempty())
      {
        chunk.setlocaldestination(this.name);
        flag2 = false;
      }
      if (flag)
      {
        chunk.setlocalgoto(this.reference.substring(1));
      }
      else if (this.reference != null)
      {
        chunk.setanchor(this.reference);
      }
      listener.add(chunk);
    }
    return true;
  }
  catch (documentexception)
  {
    return false;
  }
}

以上方法可以看到，该方法是在本类中被重写，用以处理链接的相关信息。

6.pagesize：设置纸张的类型。

public class pagesize
{
  // fields
  public static readonly rectangle _11x17;
  public static readonly rectangle a0;
  public static readonly rectangle a1;
  public static readonly rectangle a10;
  public static readonly rectangle a2;
  public static readonly rectangle a3;
  public static readonly rectangle a4;
  public static readonly rectangle a4_landscape;
  public static readonly rectangle a5;
  public static readonly rectangle a6;
  public static readonly rectangle a7;
  public static readonly rectangle a8;
  public static readonly rectangle a9;
  public static readonly rectangle arch_a;
  public static readonly rectangle arch_b;
  public static readonly rectangle arch_c;
  public static readonly rectangle arch_d;
  public static readonly rectangle arch_e;
  public static readonly rectangle b0;
  public static readonly rectangle b1;
  public static readonly rectangle b10;
  public static readonly rectangle b2;
  public static readonly rectangle b3;
  public static readonly rectangle b4;
  public static readonly rectangle b5;
  public static readonly rectangle b6;
  public static readonly rectangle b7;
  public static readonly rectangle b8;
  public static readonly rectangle b9;
  public static readonly rectangle crown_octavo;
  public static readonly rectangle crown_quarto;
  public static readonly rectangle demy_octavo;
  public static readonly rectangle demy_quarto;
  public static readonly rectangle executive;
  public static readonly rectangle flsa;
  public static readonly rectangle flse;
  public static readonly rectangle halfletter;
  public static readonly rectangle id_1;
  public static readonly rectangle id_2;
  public static readonly rectangle id_3;
  public static readonly rectangle large_crown_octavo;
  public static readonly rectangle large_crown_quarto;
  public static readonly rectangle ledger;
  public static readonly rectangle legal;
  public static readonly rectangle legal_landscape;
  public static readonly rectangle letter;
  public static readonly rectangle letter_landscape;
  public static readonly rectangle note;
  public static readonly rectangle penguin_large_paperback;
  public static readonly rectangle penguin_small_paperback;
  public static readonly rectangle postcard;
  public static readonly rectangle royal_octavo;
  public static readonly rectangle royal_quarto;
  public static readonly rectangle small_paperback;
  public static readonly rectangle tabloid;

  // methods
  static pagesize();
  public pagesize();
  public static rectangle getrectangle(string name);
}

以上的类中，我们可以看到我们可以设置需要打印的纸张类型，根据实际情况可以选择。在最下面我们看到了两种方法，一个是pagesize()设置纸张大小，一个是getrectangle()绘制矩形。

以上是对itextsharp组件的一些类和方法的简单介绍，对于表格，单元格等等类的介绍就不再继续，有兴趣的可以自己查看源代码信息。

三.itextsharp组件实例：

上面介绍了itextsharp组件的背景、特性，以及组件的核心类和方法，在这里给出一个简单的itextsharp组件操作的实例，这个实例只是一个简单的介绍。

 /// <summary>
    /// 字体
    /// </summary>
    private font _font;

    /// <summary>
    /// 文档大小
    /// </summary>
    private rectangle _rect;

    /// <summary>
    /// 文档对象
    /// </summary>
    private readonly document _document;

    /// <summary>
    /// 基础字体
    /// </summary>
    private basefont _basefont;

    /// <summary>
    /// 构造函数
    /// </summary>
    public pdfoperation()
    {
      _rect = pagesize.a4;
      _document = new document(_rect);
    }

    /// <summary>
    /// 构造函数
    /// </summary>
    /// <param name="type">页面大小(如"a4")</param>
    public pdfoperation(string type)
    {
      if (string.isnullorempty(type))
      {
        throw new argumentnullexception(type);
      }
      setpagesize(type);
      _document = new document(_rect);
    }

    /// <summary>
    /// 构造函数
    /// </summary>
    /// <param name="type">页面大小(如"a4")</param>
    /// <param name="marginleft">内容距左边框距离</param>
    /// <param name="marginright">内容距右边框距离</param>
    /// <param name="margintop">内容距上边框距离</param>
    /// <param name="marginbottom">内容距下边框距离</param>
    public pdfoperation(string type, float marginleft, float marginright, float margintop, float marginbottom)
    {
      if (string.isnullorempty(type))
      {
        throw new argumentnullexception(type);
      }
      setpagesize(type);
      _document = new document(_rect, marginleft, marginright, margintop, marginbottom);
    }


    /// <summary>
    /// 设置字体
    /// </summary>
    public void setbasefont(string path)
    {
      if (string.isnullorempty(path))
      {
        throw new argumentnullexception(path);
      }
      _basefont = basefont.createfont(path, basefont.identity_h, basefont.not_embedded);
    }

    /// <summary>
    /// 设置字体
    /// </summary>
    /// <param name="size">字体大小</param>
    public void setfont(float size)
    {
      _font = new font(_basefont, size);
    }

    /// <summary>
    /// 设置页面大小
    /// </summary>
    /// <param name="type">页面大小(如"a4")</param>
    public void setpagesize(string type)
    {
      if (string.isnullorempty(type))
      {
        throw new argumentnullexception(type);
      }
      switch (type.trim())
      {
        //枚举需要的文档纸张大小
        case "a3":
          _rect = pagesize.a3;
          break;
        case "a4":
          _rect = pagesize.a4;
          break;
        case "a8":
          _rect = pagesize.a8;
          break;
      }
    }

    /// <summary>
    /// 实例化文档
    /// </summary>
    /// <param name="os">文档相关信息（如路径，打开方式等）</param>
    public void getinstance(stream os)
    {
      if (os == null)
      {
        throw new argumentnullexception("os");
      }
      pdfwriter.getinstance(_document, os);
    }

    /// <summary>
    /// 打开文档对象
    /// </summary>
    /// <param name="os">文档相关信息（如路径，打开方式等）</param>
    public void open(stream os)
    {
      if (os == null)
      {
        throw new argumentnullexception("os");
      }
      getinstance(os);
      _document.open();
    }

    /// <summary>
    /// 关闭打开的文档
    /// </summary>
    public void close()
    {
      _document.close();
    }

    /// <summary>
    /// 添加段落
    /// </summary>
    /// <param name="content">内容</param>
    /// <param name="fontsize">字体大小</param>
    public void addparagraph(string content, float fontsize)
    {
      setfont(fontsize);
      var pra = new paragraph(content, _font);
      _document.add(pra);
    }

    /// <summary>
    /// 添加段落
    /// </summary>
    /// <param name="content">内容</param>
    /// <param name="fontsize">字体大小</param>
    /// <param name="alignment">对齐方式（1为居中，0为居左，2为居右）</param>
    /// <param name="spacingafter">段后空行数（0为默认值）</param>
    /// <param name="spacingbefore">段前空行数（0为默认值）</param>
    /// <param name="multipliedleading">行间距（0为默认值）</param>
    public void addparagraph(string content, float fontsize, int alignment, float spacingafter, float spacingbefore, float multipliedleading)
    {
      setfont(fontsize);
      var pra = new paragraph(content, _font)
      {
        alignment = alignment
      };
      if (spacingafter != 0)
      {
        pra.spacingafter = spacingafter;
      }
      if (spacingbefore != 0)
      {
        pra.spacingbefore = spacingbefore;
      }
      if (multipliedleading != 0)
      {
        pra.multipliedleading = multipliedleading;
      }
      _document.add(pra);
    }

    /// <summary>
    /// 添加图片
    /// </summary>
    /// <param name="path">图片路径</param>
    /// <param name="alignment">对齐方式（1为居中，0为居左，2为居右）</param>
    /// <param name="newwidth">图片宽（0为默认值，如果宽度大于页宽将按比率缩放）</param>
    /// <param name="newheight">图片高</param>
    public void addimage(string path, int alignment, float newwidth, float newheight)
    {
      if (string.isnullorempty(path))
      {
        throw new argumentnullexception(path);
      }
      var img = image.getinstance(path);
      img.alignment = alignment;
      // resharper disable once compareoffloatsbyequalityoperator
      if (newwidth != 0)
      {
        img.scaleabsolute(newwidth, newheight);
      }
      else
      {
        if (img.width > pagesize.a4.width)
        {
          img.scaleabsolute(_rect.width, img.width * img.height / _rect.height);
        }
      }
      _document.add(img);
    }

    /// <summary>
    /// 添加链接
    /// </summary>
    /// <param name="content">链接文字</param>
    /// <param name="fontsize">字体大小</param>
    /// <param name="reference">链接地址</param>
    public void addanchorreference(string content, float fontsize, string reference)
    {
      if (string.isnullorempty(content))
      {
        throw new argumentnullexception(content);
      }
      setfont(fontsize);
      var auc = new anchor(content, _font)
      {
        reference = reference
      };
      _document.add(auc);
    }

    /// <summary>
    /// 添加链接点
    /// </summary>
    /// <param name="content">链接文字</param>
    /// <param name="fontsize">字体大小</param>
    /// <param name="name">链接点名</param>
    public void addanchorname(string content, float fontsize, string name)
    {
      if (string.isnullorempty(content))
      {
        throw new argumentnullexception(content);
      }
      setfont(fontsize);
      var auc = new anchor(content, _font)
      {
        name = name
      };
      _document.add(auc);
    }

以上的实例比较的简单，主要是用作简单介绍组件的用法。如果需要将组件设计的更加通用，我们可以将组件的相关类和方法重写，并且可以开发一套cs或者bs程序，实现组件的图形化操作，图形化操作生成文件模板。文件模板可以将相关信息序列化（json或者二进制），在项目中直接加载模型，并将数据绑定在模板中，实现pdf打印的动态配置。

这个程序的开发难度一般，如果有兴趣的可以自行开发一套工具，可以更好的实现我们的项目pdf打印功能。

四.总结：

上面介绍了itextsharp组件的相关信息，在这个系列的组件介绍中，对于组件的介绍都是比较的简单，旨在向大家介绍这个组件，在实际的开发中，我们可以根据实际情况自行选择相应的组件，组件没有绝对的好坏，只有合适的场景。

以上讲解若有错误和不足之处，希望大家多多见谅和多多提出意见和建议。也希望大家多多支持。