Click here to Skip to main content
Click here to Skip to main content

View PDF files in C# using the Xpdf and muPDF library, Print PostScript.

, 26 Nov 2010 GPL3
Rate this:
Please Sign up or sign in to vote.
Wrapper C# class written in C++\CLI and a sample implementation in C# to render PDF files.

AFPDFLib

Introduction 

Xpdf is an Open Source library released under GPL license; they have an ActiveX with commercial license, but some time ago, before I knew about this commercial control, I wrote this wrapper library to render PDF files in C#. 

Background

The basic idea is create a preview of PDF files in C#. After looking at many places in the internet, I found this wonderful library; the only problem is that the library uses XLib, and there is no XLib available for Windows. Fortunately, Xpdf can render the generated PDF into a Win32 DC.

Writting the wrapper

C++\CLI can mix managed and unmanaged code thanks to the IJW technology, so I was thinking that maybe I could to link the xpdf lib to the wrapper. The problem is that xpdf has some classes that are also declared in .Net, the solution was compile a C++ project with a class that includes only the necessary files to do the interop.
This library (AFPDFLib) contains a simple class that works like a proxy between C++ and C++\CLI, keeping the xpdf objects into the unmanaged Heap.
The C# wrapper is linked to AFPDFLib statically, and this only includes:
AFPDFDocInterop.h
OutlineItemInterop.h
SearchResultInterop.h
The classes:
AFPDFDoc -> Implement the methods that needs xpdf.
AFPDFDocInterop -> Write the methods to wrap into C#
PDFWrapper -> Wrapped methods

Marshal Strings:
IntPtr ptr = Marshal::StringToCoTaskMemAnsi(fileName);
char *singleByte= (char*)ptr.ToPointer();
try{
}finally{
     Marshal::FreeCoTaskMem(ptr);
}   

For releasing resources is necessary implement IDisposable:

!PDFWrapper()
{
   _pdfDoc->Dispose();
} 

Using the code  

The file xpdfWin-Interop.sln includes all the necessary files, you can also download the last version from http://www.foolabs.com/xpdf/ and recompile without the files that requires XLib.

The Build Project Order is as follows: freetype,xpdf,AFPDFLib, PDFLibNet. Once compiled PDFLibNet, it can be used in C# code:    

OpenFileDialog dlg = new OpenFileDialog();
dlg.Filter = "Portable Document Format (*.pdf)|*.pdf";
if (dlg.ShowDialog() == DialogResult.OK)
{
    _pdfDoc = new PDFLibNet.PDFWrapper();
    _pdfDoc.LoadPDF(dlg.FileName);
    _pdfDoc.CurrentPage = 1;

   PictureBox pic =new PictureBox();
   pic.Width=800;
   pic.Height=1024;
   _pdfDoc.FitToWidth(pic.Handle);
   pic.Height = _pdfDoc.PageHeight;
   _pdfDoc.RenderPage(pic.Handle);
   
   Bitmap _backbuffer = new Bitmap(_pdfDoc.PageWidth, _pdfDoc.PageHeight);
   using (Graphics g = Graphics.FromImage(_backbuffer))
   {
       _pdfDoc.RenderHDC(g.GetHdc);
       g.ReleaseHdc();
   }
   pic.Image = _backbuffer;
}   

It is necessary create a PictureBox because the class implements only a method that accepts an HWND, because in the first instance, I was trying to implement the scroll into the same control that the PDF is rendered. In the included sample, the scroll is controlled by a Panel container.

Xpdf can export the PDF to a PostScript file. For printing this is the best option if you have a PostScript Printer:       

PSOutputDev *psOut =new PSOutputDev((char *)fileName,m_PDFDoc->getXRef(),m_PDFDoc->getCatalog(),fromPage,toPage,psModePS);
if(psOut->isOk()){
    m_PDFDoc->displayPages(psOut,fromPage,toPage,PRINT_DPI,PRINT_DPI,0,gTrue,globalParams->getPSCrop(),gTrue);
}
delete psOut;  

The file must be sended in RAW format (http://support.microsoft.com/kb/322091)

JPG Export 

For async export: 

 _doc.ExportJpg(filename, 
1,        //From page
1,        //To page
150,      //Resolution in DPI
90,       //Jpg quality 
if you need a sync operation its posible especify a wait time:
 _doc.ExportJpg(filename, 
1,        //From page
1,        //To page
150,      //Resolution in DPI
90,       //Jpg quality
-1);      //Time to wait, -1 to infinite.
 If the file name does not contains a %d token (for the page number), then the procedure replaces .jpg with -page%d.jpg.  PDFWrapper exposes two events ExportJpgProgress and ExportJpgFinished. Both events are called from the exporting Thread, so it is necesary to make a security call using Invoke, check frmExportJpg for a sample.  

History:    

06\July\2009:
  • Full deployed solution.
  • Updated to xpdf 3.0.2 version.
  • FreeType updated to 2.3.1
  • When click in a bookmark and search, the page scroll to the correct position.
  • PostScript implemented. 
  • Now gets the Title, Author.  
08\July\2009
  • Some memory leaks corrected 
  • Prerender next page in new thread 
  • Cache of pages  
  • Mouse Scrolling 
  • Mouse Navigation 
  • Load links from page (LinkURI, LinkGoTo) 
11\July\2009 
  • Using DIB Sections,  fixes the problem with the zoom.
  • Added control PageViewer, now render only the viewable area
  • Open password protected files.
  • Export to txt
  • Export to jpg
12\July\2009
  • Added support for Unicode in Bookmarks, title, subject, keywords...
  • Added support for named destinations
13\July\2009
  • Fixed some bugs.
  • Added support for unicode search
20\July\2009  
  • Multithread jpg export
  • Fixed others bugs
07\Nov\2009 
  • Added MuPDF as second renderer. 
 26\NOV\2010 Know issues:     MuPDF has some problems with transparency, but is faster than xpdf.  A couple of memory leaks.

IMPORTANT:         

MuPDF uses recursion for analyze the tree document, so is necessary increment the Stack Size to at least 4mb to avoid problems with some complex files (editbin for C#, VB.Net exe's). Soon or later the recursion causes an stack overflow if the tree is so big, so while it is fixed that is the most important issue.

To Do:        

- Apply last xpdf patche - Show multiple pages in the viewer. - Improve user interface. - Implement LoadFromStream for MuPDF. There is missing some functionality that can be extracted from xpdf: - Enable selection, image extraction and instant snapshot. - Print in non PostScript printers.

License

This article, along with any associated source code and files, is licensed under The GNU General Public License (GPLv3)

Share

About the Author

Antonio Sandoval
Engineer HidraQuim SA de CV
Mexico Mexico
I'm a Chemical Engineering that loves the programming.
2003 - Graduated from Technical Programmer UNIVA México.
2009 - Graduated from Chemical Engineering Universidad de Guadalajara, Mexico.
Programmer by Hobby since 6 years ago.

Comments and Discussions

 
QuestionHow to search text while using mupdf [modified] Pinmembermiralireza27-May-13 20:36 
AnswerRe: How to search text while using mupdf PinmemberMember 105864715-Aug-14 0:16 
QuestionLinks? Pinmembertntblow26-Mar-13 11:03 
QuestionHelp!!! I need .net 1.1 version Pinmemberxiaoheibai18-Nov-12 23:15 
QuestionWhere can I get .sln project file?? PinmemberPhiru3-Apr-12 15:05 
QuestionIs that easy to do a whole document search and list all results? PinmemberMayaya6520-Feb-12 20:18 
QuestionIs this Compatible with .Net FrameWork 4.0? PinmemberSankaroo72-Feb-12 2:48 
AnswerRe: Is this Compatible with .Net FrameWork 4.0? PinmemberBarbara Post1-Jun-12 2:58 
Questioncan I used PDFLibNet.dll in commercial applications on the CPOL license?? Pinmemberkikimart.japan25-Dec-11 18:59 
QuestionPDFLibNet.dll for VS2003 [modified] Pinmemberlianganton6-Dec-11 19:38 
QuestionText Position Pinmemberdavfeu29-Nov-11 22:23 
QuestionHola antonio, sin embargo cuando levanto una version en visual basic PinmemberGL_Terminator11-Oct-11 8:17 
AnswerRe: Hola antonio, sin embargo cuando levanto una version en visual basic PinmemberAntonio Sandoval11-Oct-11 10:03 
QuestionHelp... System.AccessViolationException PinmemberGabriel_7524-Aug-11 17:26 
AnswerRe: Help... System.AccessViolationException PinmemberAntonio Sandoval11-Oct-11 10:04 
QuestionSearch function crashes Pinmembercricrides3-Aug-11 3:38 
QuestionHow can i get this dll CJK(chinese Japanise Koreal )supported? Pinmemberzhuoml2-Aug-11 17:47 
Question.net 2.0. PinmemberJosip Habjan19-Jul-11 1:11 
QuestionHow can I merge the code with the latest mupdf? Pinmemberwmjordan5-Jul-11 0:46 
GeneralI have the fix for the muPDF rendering memory leak [modified] PinmemberRon Schuler29-May-11 16:57 
AnswerRe: I have the fix for the muPDF rendering memory leak PinmemberAntonio Sandoval30-May-11 6:54 
GeneralRe: I have the fix for the muPDF rendering memory leak PinmemberRon Schuler30-May-11 7:08 
GeneralRe: I have the fix for the muPDF rendering memory leak PinmemberRon Schuler30-May-11 7:20 
GeneralRe: I have the fix for the muPDF rendering memory leak [modified] PinmemberPizzamaka32122-Nov-11 2:29 
GeneralRenderNotifyFinished handler not being removed PinmemberRon Schuler25-May-11 17:48 
GeneralRe: RenderNotifyFinished handler not being removed [modified] PinmemberRon Schuler28-May-11 5:41 
GeneralRe: RenderNotifyFinished handler not being removed PinmemberAntonio Sandoval28-May-11 8:33 
GeneralRe: RenderNotifyFinished handler not being removed PinmemberRon Schuler28-May-11 7:25 
GeneralRe: RenderNotifyFinished handler not being removed PinmemberAntonio Sandoval28-May-11 8:38 
GeneralSaveAs in PDFWrapper without loseless color on Render [modified] Pinmemberpioner198712-May-11 0:53 
GeneralRe: SaveAs in PDFWrapper without loseless color on Render PinmemberAntonio Sandoval20-May-11 18:42 
GeneralPlease help! Pinmemberwsmwlh11-Apr-11 16:43 
AnswerRe: Please help! PinmemberAntonio Sandoval16-May-11 10:54 
QuestionRe: Please help! Pinmemberwsmwlh18-May-11 23:25 
AnswerRe: Please help! PinmemberAntonio Sandoval19-May-11 6:03 
QuestionRe: Please help! [modified] Pinmemberwsmwlh19-May-11 23:07 
AnswerRe: Please help! PinmemberAntonio Sandoval20-May-11 18:40 
QuestionRe: Please help! Pinmemberwsmwlh25-May-11 17:48 
General"An attempt was made to load a program with an incorrect format." Pinmembermartinrousev7-Apr-11 4:55 
GeneralRe: "An attempt was made to load a program with an incorrect format." Pinmemberdantrech10-May-11 12:14 
GeneralRe: "An attempt was made to load a program with an incorrect format." PinmemberAntonio Sandoval10-May-11 14:07 
GeneralRe: "An attempt was made to load a program with an incorrect format." PinmemberAntonio Sandoval16-May-11 10:53 
GeneralMy vote of 5 Pinmembercjan198523-Mar-11 23:51 
QuestionCan it be used with c++? Pinmembercjan198523-Mar-11 23:50 
QuestionCannot compile in VS2010 PinmemberMarco Giacinti15-Feb-11 23:19 
NewsRe: Cannot compile in VS2010 PinmemberAntonio Sandoval16-May-11 10:53 
GeneralMy vote of 4 PinmemberSlarti421-Feb-11 23:40 
GeneralPrinting direcly without GUI PinmemberSlarti421-Feb-11 23:38 
GeneralRe: Printing direcly without GUI PinmemberAntonio Sandoval2-Feb-11 12:32 
GeneralMy vote of 4 PinmemberMauro Gagna26-Jan-11 5:31 

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
Web01 | 2.8.1411023.1 | Last Updated 26 Nov 2010
Article Copyright 2009 by Antonio Sandoval
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid