Click here to Skip to main content
11,716,938 members (87,776 online)
Click here to Skip to main content

Creating PDF with nFOP

, 11 Jan 2006 CPOL 139.6K 2.4K 47
Rate this:
Please Sign up or sign in to vote.
How to use generate PDF files on the fly using nFOP

Introduction

nFOP is an elegant solution to generate PDF on the fly. It is originally a Java open source product that has been migrated to .NET.

The purpose of this article is to show the use of nFOP to generate a PDF file from XML data. We won't describe the FO format here. Many excellent articles exist on the Web about FO which is a W3C standard. Unfortunately it doesn't seem to be much known by the .NET community so far.

First, you have to download nFOP from here.

Using the Code

Here is the data in input - my favourite French books:

Books.xml

<?xml version="1.0" encoding="utf-8" ?>
<Books>
  <Book>
    <Title>Madame Bovary</Title>
    <Author>Gustave Flaubert</Author>
    <Price>10</Price>
  </Book>
  <Book>
    <Title>Bel Ami</Title>
    <Author>Maupassant</Author>
    <Price>18</Price>
  </Book>
  <Book>
    <Title>La Curée</Title>
    <Author>Emile Zola</Author>
    <Price>12</Price>
  </Book>
  <Book>
    <Title>Les Chouans</Title>
    <Author>Honoré de Balzac</Author>
    <Price>15</Price>
  </Book>
</Books>

Here is now the XSL transformation that I will apply to this XML. I create a table in FO language, with three columns. The rows will be generated by the XSL transformation, one for each book.

BookFo.xsl

<fo:table-body>
      <fo:table-row>
        <fo:table-cell>
          <fo:block>Title</fo:block>
        </fo:table-cell>
        <fo:table-cell>
          <fo:block>Author</fo:block>
        </fo:table-cell>
        <fo:table-cell>
          <fo:block>Price</fo:block>
        </fo:table-cell>
      </fo:table-row>
      <xsl:for-each select="Books/Book">
        <fo:table-row>
          <fo:table-cell>
            <fo:block>
              <xsl:value-of select=".//Title" />
            </fo:block>
          </fo:table-cell>
          <fo:table-cell>
            <fo:block>
              <xsl:value-of select=".//Author" />
            </fo:block>
          </fo:table-cell>
          <fo:table-cell>
            <fo:block>
              <xsl:value-of select=".//Price" />
            </fo:block>
          </fo:table-cell>
        </fo:table-row>
      </xsl:for-each>
    </fo:table-body>
  </fo:table>

In Visual Studio, reference the nFop assembly ApacheFop.Net.dll and the J# assembly vjslib.dll.

You will need to add the following namespaces to your class:

using System.Xml;
using System.Xml.Xsl;
using System.Xml.XPath;
using org.apache.fop;
using org.apache.fop.apps;
using org.apache.fop.tools;
using org.xml.sax;
using java.io;

We call the classic XML/XSL transformation to produce the FO file:

// Load the FO style sheet.
XslCompiledTransform xslt = new XslCompiledTransform();
xslt.Load("bookFo.xsl");

// Execute the transform and output the results to a file.
xslt.Transform("books.xml", "books.fo");

At last, here comes the most interesting part, the use of NFOP to generate the PDF file.

Here is the method that does the job:
private void GeneratePDF(string foFile, string pdfFile)
{
    FileInputStream streamFO = new FileInputStream(foFile);
    InputSource src = new InputSource(streamFO);
    FileOutputStream streamOut = new FileOutputStream(pdfFile);
    Driver driver = new Driver(src, streamOut);
    driver.setRenderer(1);
    driver.run();
    streamOut.close();
}

Conclusion

nFOP is an easy solution to implement and it is free. Because the PDF structure is described in an XML file, it is easy to configure its disposition, which clients always ask for.

To learn more about FOP, visit the Apache site and download the Java version. It contains plenty of samples of FO files and good documentation.

History

  • 11th January, 2006: Initial post

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Jerome Bellanger
Software Developer (Senior) Freelance
France France
No Biography provided

You may also be interested in...

Comments and Discussions

 
QuestionError assembly Pin
Member 953878123-Oct-12 3:32
memberMember 953878123-Oct-12 3:32 
SuggestionEditors for FOP Pin
Member 827588227-Nov-11 0:49
memberMember 827588227-Nov-11 0:49 
GeneralMy vote of 5 Pin
vinayak.bhadage19-Apr-11 22:52
membervinayak.bhadage19-Apr-11 22:52 
QuestionDriver.setRenderer(8); not working Pin
pricksaw24-May-10 13:43
memberpricksaw24-May-10 13:43 
GeneralSecured PDF Generation Pin
vinvino200122-Apr-10 21:32
membervinvino200122-Apr-10 21:32 
GeneralRe: Secured PDF Generation Pin
WiseLearner11-Feb-13 8:04
memberWiseLearner11-Feb-13 8:04 
GeneralRe: Secured PDF Generation Pin
vinvino200111-Feb-13 17:48
membervinvino200111-Feb-13 17:48 
QuestionDriver present in which library? ISO8859_1 error? Pin
pricksaw9-Feb-10 13:24
memberpricksaw9-Feb-10 13:24 
AnswerRe: Driver present in which library? ISO8859_1 error? Pin
pricksaw9-Feb-10 18:22
memberpricksaw9-Feb-10 18:22 
GeneralRe: Driver present in which library? ISO8859_1 error? Pin
pricksaw11-Feb-10 16:34
memberpricksaw11-Feb-10 16:34 
GeneralI am getting error like this Pin
Shaik Haneef14-Sep-09 20:41
memberShaik Haneef14-Sep-09 20:41 
GeneralRe: I am getting error like this Pin
Kotty19856-Nov-09 4:51
memberKotty19856-Nov-09 4:51 
GeneralIssue parsing out encoded html Pin
coolaid0925-Aug-09 8:51
membercoolaid0925-Aug-09 8:51 
Questionimages Pin
coolaid0920-Aug-09 9:34
membercoolaid0920-Aug-09 9:34 
AnswerRe: images Pin
pricksaw1-Mar-10 11:08
memberpricksaw1-Mar-10 11:08 
QuestionFop license? Pin
pereszczako8-Jun-09 22:39
memberpereszczako8-Jun-09 22:39 
QuestionBarcode fonts embedded using the userconfig.xml file Pin
djblues30-Apr-09 8:46
memberdjblues30-Apr-09 8:46 
GeneralIssue with FOP Pin
sonu941-Dec-08 22:09
membersonu941-Dec-08 22:09 
Generalreference-orientation does not work Pin
Member 212122031-Mar-08 9:14
memberMember 212122031-Mar-08 9:14 
QuestionLatin2 character set Pin
Gabor10-Dec-07 23:41
sussGabor10-Dec-07 23:41 
QuestionBuild Pin
lokesh_sg7-Nov-07 0:23
memberlokesh_sg7-Nov-07 0:23 
QuestionHyphenation Pin
Daniele Fusi28-Mar-07 23:34
memberDaniele Fusi28-Mar-07 23:34 
GeneralJava does not work Pin
Member #385632223-Feb-07 5:42
memberMember #385632223-Feb-07 5:42 
GeneralRe: Java does not work Pin
Wingnut121327-Feb-07 8:02
memberWingnut121327-Feb-07 8:02 
QuestionLarge FO files take very long time to process Pin
Dadou00220-Nov-06 19:45
memberDadou00220-Nov-06 19:45 
Generalunable to use XslCompiledTransform .NET1.1 Pin
newbie1310-Oct-06 7:26
membernewbie1310-Oct-06 7:26 
AnswerRe: unable to use XslCompiledTransform .NET1.1 Pin
Sid DeLuca25-Jan-07 6:04
memberSid DeLuca25-Jan-07 6:04 
GeneralFop and arabic support Pin
ssam14-Feb-06 7:34
memberssam14-Feb-06 7:34 
GeneralRe: Fop and arabic support Pin
ssam14-Feb-06 23:07
memberssam14-Feb-06 23:07 
GeneralRe: Fop and arabic support Pin
Sohid6-Mar-07 3:00
memberSohid6-Mar-07 3:00 
GeneralRe: Fop and arabic support Pin
ssam6-Mar-07 22:13
memberssam6-Mar-07 22:13 
GeneralRe: Fop and arabic support Pin
MystiqueMan17-Mar-07 15:15
memberMystiqueMan17-Mar-07 15:15 
GeneralRe: Fop and arabic support Pin
ssam15-Jun-07 0:30
memberssam15-Jun-07 0:30 
QuestionFO-Editor? Pin
Thomas M.18-Jan-06 1:11
memberThomas M.18-Jan-06 1:11 
AnswerRe: FO-Editor? Pin
gsaielli20-Jan-06 2:23
membergsaielli20-Jan-06 2:23 
GeneralRe: FO-Editor? Pin
Thomas M.20-Jan-06 2:43
memberThomas M.20-Jan-06 2:43 
GeneralRe: FO-Editor? Pin
Jaro30-Jan-06 9:12
memberJaro30-Jan-06 9:12 
Generalreport viewer Pin
ignatandrei13-Jan-06 4:35
memberignatandrei13-Jan-06 4:35 
Generaluncomplete FOP portage Pin
bxb12-Jan-06 0:09
memberbxb12-Jan-06 0:09 
GeneralRe: uncomplete FOP portage Pin
Jerome Bellanger13-Jan-06 8:20
memberJerome Bellanger13-Jan-06 8:20 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.150901.1 | Last Updated 11 Jan 2006
Article Copyright 2006 by Jerome Bellanger
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid