Search code examples
c#.netpdf-generationpechkintuespechkin

How can I add a header and footer to the generated PDF


I'm using Gmanny's Pechkin Pdf library and it's working perfectly. Here's is my code:

  private void CreatePdfPechkin(string htmlString, string fileName)
        {
            //Transform the HTML into PDF
            var pechkin = Factory.Create(new GlobalConfig()
            .SetMargins(new Margins(100, 50, 100, 100))
              .SetDocumentTitle("Test document")
              .SetPaperSize(PaperKind.A4)
               .SetCopyCount(1)
                           //.SetPaperOrientation(true)
                          // .SetOutputFile("F:/Personal/test.pdf")

             );
            ObjectConfig oc = new ObjectConfig();
            oc.Footer.SetLeftText("[page]");
            oc.Footer.SetTexts("[page]", "[date]", "[time]");
            oc.Header.SetCenterText("TEST HEADER TEST1");
            oc.Header.SetHtmlContent("<h1>TEST HEADER V2</h1>");
            oc.SetAllowLocalContent(true);
           //// create converter
            //IPechkin ipechkin = new SynchronizedPechkin(pechkin);

            // set it up using fluent notation
            var pdf = pechkin.Convert(new ObjectConfig()
                        .SetLoadImages(true).SetZoomFactor(1.5)
                        .SetPrintBackground(true)
                        .SetScreenMediaType(true)
                        .SetCreateExternalLinks(true), htmlString);

           //Return the PDF file
            Response.Clear();
            Response.ClearContent();
            Response.ClearHeaders();
            Response.ContentType = "application/pdf";
            Response.AddHeader("Content-Disposition", string.Format("attachment;filename=test.pdf; size={0}", pdf.Length));
            Response.BinaryWrite(pdf);
            Response.Flush();
            Response.End();
//            byte[] pdf = new Pechkin.Synchronized.SynchronizedPechkin(
//new Pechkin.GlobalConfig()).Convert(
//    new Pechkin.ObjectConfig()
//   .SetLoadImages(true)
//   .SetPrintBackground(true)
//   .SetScreenMediaType(true)
//   .SetCreateExternalLinks(true), htmlString);
//            using (FileStream file = System.IO.File.Create(@"F:\Pankaj WorkSpace\"+  fileName))
//            {
//                file.Write(pdf, 0, pdf.Length);
//            }
        }

But now I want to add header, footer and page Number, can somebody suggest how to do that? I know it is possible through Object config I tried but its not working..


Solution

  • Headers and footers using the below very basic examples work for me.

    Using Pechkin:

    GlobalConfig gc = new GlobalConfig();
    gc.SetMargins(new Margins(300, 100, 150, 100))
      .SetDocumentTitle("Test document")
      .SetPaperSize(PaperKind.Letter);
    IPechkin pechkin = new SynchronizedPechkin(gc);
    
    ObjectConfig oc = new ObjectConfig();
    oc.SetCreateExternalLinks(false);
    oc.SetFallbackEncoding(Encoding.ASCII);
    oc.SetLoadImages(false);
    oc.Footer.SetCenterText("I'm a footer!");
    oc.Footer.SetLeftText("[page]");
    oc.Header.SetCenterText("I'm a header!");
    
    byte[] result = pechkin.Convert(oc, "<h1>My Website</h1>");
    System.IO.File.WriteAllBytes(@"c:\pechkinTest.pdf", result);
    

    I'd recommend you switch to Tuespechkin though. This is an active fork of Pechkin which includes many bugfixes. Unfortunately active development on Pechkin ceased since 2013.

    Using Tuespechkin:

    var document = new HtmlToPdfDocument
    {
        GlobalSettings =
        {
            ProduceOutline = true,
            DocumentTitle = "My Website",
            PaperSize = PaperKind.A4,
            Margins =
            {
                All = 1.375,
                Unit = Unit.Centimeters
            }
        },
        Objects = {
            new ObjectSettings
            {
                HtmlText = "<h1>My Website</h1>",
                HeaderSettings = new HeaderSettings{CenterText = "I'm a header!"},
                FooterSettings = new FooterSettings{CenterText = "I'm a footer!", LeftText = "[page]"}
            }
        }
    };
    
    IPechkin converter = Factory.Create();
    byte[] result = converter.Convert(document);
    System.IO.File.WriteAllBytes(@"c:\tuespechkinTest.pdf", result);
    

    Your issue is this. Instead of creating a new second ObjectConfig, you need to pass the OC you created before which includes the header and footer. Just combine them like this:

    ObjectConfig oc = new ObjectConfig();
    oc.SetLoadImages(true);
    oc.SetZoomFactor(1.5);
    oc.SetPrintBackground(true);
    oc.SetScreenMediaType(true);
    oc.SetCreateExternalLinks(true);
    oc.Footer.SetLeftText("[page]");
    oc.Footer.SetCenterText("I'm a footer!");
    oc.Header.SetCenterText("TEST HEADER TEST1");
    
    var result = pechkin.Convert(oc, "<h1>My Website</h1>");
    System.IO.File.WriteAllBytes(@"c:\pechkinTest.pdf", result);