Ibex.PDF.Creator 6.4.2

.NET 6.0
Install-Package Ibex.PDF.Creator -Version 6.4.2
dotnet add package Ibex.PDF.Creator --version 6.4.2
<PackageReference Include="Ibex.PDF.Creator" Version="6.4.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Ibex.PDF.Creator --version 6.4.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Ibex.PDF.Creator, 6.4.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Ibex.PDF.Creator as a Cake Addin
#addin nuget:?package=Ibex.PDF.Creator&version=6.4.2

// Install Ibex.PDF.Creator as a Cake Tool
#tool nuget:?package=Ibex.PDF.Creator&version=6.4.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Ibex.PDF.Creator

Ibex is a scalable standards-compliant PDF creation component for .Net.

See https://www.xmlpdf.com for more information.

Ibex helps you quickly create complex documents providing complete control over page layout and content. Ibex supports a wide range of layout functionality including page headers and footers, multi-column pages, page numbering, cross-referencing, footnotes, index creation and much more.

Ibex supports complex table layouts like this:

tables.png

including cells which span multiple rows and columns, aligning data on decimal points regardless of font size, conditional headers and footers (for saying "continued on next page"), conditional borders at page breaks and lots more.

Bookmarks can be automatically generated using XSLT, including clickable page numbers which link to the correct page in the document:

bookmarks.png

Ibex supports SVG images including transparency, linear and radial gradients, and SVG images which contain other bitmap images:

svg.png

A simple example using Ibex .NET from C#

This example shows how to call Ibex from a C# program and create a PDF file from XML and XSL files.

In this example we use an XML file containing the data we want to get into the PDF file, and and XSL stylesheet which transforms the XML into the FO syntax which Ibex understands. The XML file

The XML used in this example contains text held in one or more paragraph elements. It looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<text>
  <para>hello world</para>
</text>

An XSL stylesheet is used to transform the XML into XSL-FO syntax. Using a stylesheet means that when the data changes (in the XML file) we do not have to make any changes to the C# program or the XSL stylesheet. If we add new elements to the XML which we want to appear in the PDF file, then we will need to change the XSL stylesheet, but we won't have to change the C# program. And changing the XSL is simple because we don't need to recompile it and can just use a text editor to maintain it.

The XSL used in this example looks like this:

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0"
  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  xmlns="http://www.w3.org/1999/XSL/Format"
  xmlns:ibex="http://www.xmlpdf.com/2003/ibex/Format">
  
  <xsl:strip-space elements="*"/>

  <xsl:template match="text">

    <fo:root>

      <fo:layout-master-set>
        <fo:simple-page-master master-name="page-layout">
          <fo:region-body margin="2.5cm" region-name="body" background-color="#dddddd"/>
        </fo:simple-page-master>
      </fo:layout-master-set>

      <fo:page-sequence master-reference="page-layout">
        <fo:flow flow-name="body">
          <xsl:apply-templates select="para"/>
        </fo:flow>
      </fo:page-sequence>

    </fo:root>

  </xsl:template>

  <xsl:template match="para">
    <fo:block>
      <xsl:apply-templates select="text()"/>
    </fo:block>
  </xsl:template>

</xsl:stylesheet>

Basically what this XSL does it output the <fo:root> element of the FO file, which contains the fo:layout-master-set defining the page structure, and then output each <para> element from the XML inside an FO block element.

The C# program used in this example is:

using ibex4;

public class HelloWorld {
    static void Main( string[] args ) {
        if( args.Length < 3 ) {
            Console.WriteLine( "usage:hello xml-file xsl-file pdf-file" );
            return;
        }

        FileStream xml = new FileStream( args[0], FileMode.Open, FileAccess.Read );
        FileStream xsl = new FileStream( args[1], FileMode.Open, FileAccess.Read );
        FileStream pdf = new FileStream( args[2], FileMode.Create, FileAccess.Write );

        FODocument doc = new FODocument();

        doc.generate( xml, xsl, pdf );
    }
}

What this program does is:

  • check that we have 3 arguments;
  • create streams for input of the XML and XSL, and output of the PDF;
  • create an Ibex FODocument object;
  • call the generate() method to create the PDF file.

The program can be compiled from the command line, linking Ibex like this:

Create a new project class, for example, "hello"

dotnet new console --name hello
cd hello
dotnet add package Ibex.PDF.Creator

edit the Program.cs file created when the project was created and replace its contents with this:

using ibex4;

public class HelloWorld {
    static void Main( string[] args ) {
        if( args.Length < 3 ) {
            Console.WriteLine( "usage:hello xml-file xsl-file pdf-file" );
            return;
        }

        FileStream xml = new FileStream( args[0], FileMode.Open, FileAccess.Read );
        FileStream xsl = new FileStream( args[1], FileMode.Open, FileAccess.Read );
        FileStream pdf = new FileStream( args[2], FileMode.Create, FileAccess.Write );

        FODocument doc = new FODocument();

        doc.generate( xml, xsl, pdf );
    }
}

build the project

    dotnet build

This creates the program hello.exe. To run it we pass the names of the XML, XSL and PDF files on the command line like this:

dotnet run hello.xml hello.xsl hello-world.pdf

This will create the file hello.pdf containing the data from hello-world.xml.

See https://www.xmlpdf.com for more information.

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.4.2 44 5/9/2022
6.4.1 42 5/9/2022
6.3.1 32 5/9/2022
6.2.6 70 4/3/2022
6.2.4 54 4/2/2022
6.2.3 45 3/30/2022
6.2.2 44 3/27/2022
6.2.1 57 3/19/2022
6.1.1 111 3/6/2022
6.0.20-beta 37 2/23/2022
6.0.1-beta 37 2/12/2022
6.0.0-beta 44 2/11/2022