Getting Started on .NET

Integrate into .NET

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Adding GdPicture to Your Application

This section explains how to add GdPicture.NET to your application.

Adding a Reference to the NuGet Package

First, add a reference to the GdPicture.API NuGet package by following these steps:

  1. In Visual Studio, create a new project or open the code of your existing application. For more information on creating a new project, see the Microsoft documentation. It’s recommended to create a project that runs on .NET 6.0 or newer.

  2. Select Project > Manage NuGet Packages.

  3. In the Package source field, select nuget.org.

  4. Click the Browse tab, and then search for GdPicture.

  5. Select one of the following options:

    • Recommended: If your application runs on .NET 6.0 or newer, select GdPicture.API, and then click Install.

    • If your application runs on .NET 4.5 or .NET Core 3.1, select GdPicture, and then click Install.

Alternatively, add a reference to the GdPicture DLL file.

Importing GdPicture.NET to Your Application

Import GdPicture.NET to your application by referencing it in the beginning of all the code files where you use GdPicture.NET SDK:

using GdPicture14;
Imports GdPicture14;

For more information on the using directive in C#, see the Microsoft documentation.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Converting a Word Document to a PDF

In this example, convert a Word document to a PDF by following these steps:

  1. Create a GdPictureDocumentConverter object.

  2. Load the source Word document by passing its path to the LoadFromFile method of the GdPictureDocumentConverter object.

  3. Convert the source document to PDF by passing the path of the output file to the SaveAsPDF method of the GdPictureDocumentConverter object.

using GdPictureDocumentConverter gdpictureDocumentConverter = new GdPictureDocumentConverter();
gdpictureDocumentConverter.LoadFromFile(@"C:\temp\source.docx");
gdpictureDocumentConverter.SaveAsPDF(@"C:\temp\output.pdf");
Using gdpictureDocumentConverter As GdPictureDocumentConverter = New GdPictureDocumentConverter()
gdpictureDocumentConverter.LoadFromFile("C:\temp\source.docx")
gdpictureDocumentConverter.SaveAsPDF("C:\temp\output.pdf")

With this example, you can batch convert multiple Word files.

After installation, look at our code samples to see some examples of how to use GdPicture.NET.

Integrate into Visual Basic 6

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Your First Application Using COM

GdPicture.NET includes a COM edition that can be used like a COM/ActiveX component with IntelliSense support in environments supporting this technology (e.g. Visual Basic 6, Visual C++ with MFC, HTML pages, Delphi, Visual FoxPro, and more).

This edition is automatically registered on your computer when installing the GdPicture.NET package.

The DLL is located in [INSTALLATION FOLDER]\Redist\COM Interop\, and it can be registered on other computers using the regasm command with admin privileges, like this:

  • %SystemRoot%\Microsoft.NET\Framework\v4.0.30319\ **regasm.exe** GdPicture.NET.14.dll /codebase /tlb

The DLL can be unregistered using regasm.exe /u, like this:

  • %SystemRoot%\Microsoft.NET\Framework\v4.0.30319\ **regasm.exe /u** GdPicture.NET.14.dll /codebase /tlb

Visual Basic 6

This section provides you with a step-by-step guide to getting started using GdPicture.NET with Microsoft Visual Basic 6.

You can find three sample projects demonstrating the use of several GdPicture.NET features using COM Interop in the [INSTALLATION FOLDER]\Samples\WinForm\vb6 folder.

Information

IntelliSense is fully supported in Visual Basic 6.

  1. Start with a new project (or open an existing project) and click OK.

New Project

  1. Click Project in the application menu, and then select References…

Project > References

  1. Scroll through the list of available references, check the GdPicture.NET 14 - Document Imaging SDK entry, and click OK.

Selecting GdPicture.NET 14 - Document Imaging SDK

  1. Using the Object Browser (accessed with the F2 shortcut), you’ll see all the classes, enumerations, methods, properties, etc…

Using the Object Browser

  1. Now you can use GdPicture.NET like any other object in your code.

Integrate into Visual C++ and MFC

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Visual C++ with MFC

This section provides you with a step-by-step guide to getting started using GdPicture.NET with Visual C++ (up to VS 2017) with an MFC environment.

You can find an example using COM Interop in the [INSTALLATION FOLDER]\Samples\WinForm\c++ mfc folder.

Information

IntelliSense is fully supported in Visual C++.

  1. Start a new project in Visual Studio > File > New > Project. Then select MFC/ATL > MFC Application.

Visual Studio > MFC/ATL > MFC Application

  1. Set your Application Type to Dialog based.

Dialog based Application Type

  1. Copy GdPicture.NET.14.dll and GdPicture.NET.14.tlb to your application folder.

  2. To import the DLL, use Project > Class Wizard (available until VS 2017), choose the Add Class… dropdown, and select MFC Class From TypeLib…

Select MFC Class From TypeLib…

  1. Under Add class from: in the wizard dialog, select File. Then, click the … button on the right-hand side, next to the Location field, to select the GdPicture.NET.14.tlb file located in [INSTALLDIR]/Redist/COM Interop or in your application directory if you copied it.

  2. Select the interfaces you need from the list to generate the C++ wrappers.

Add class and select interfaces

Information

Each GdPicture class, which also contains events, will be split into two classes: one defining events, and another one defining properties and methods. For example, to import the `GdPicturePDF` class, select `__GdPicturePDF` and `GdPicturePDF`.

  1. Change the way the DLL is imported in generated header files (if needed). Change no_namespace to raw_interfaces_only in the #import code line in the generated headers.

Change <code>no_namespace</code> to <code>raw_interfaces_only</code>

  1. Initialize COM objects in your application by adding HRESULT hr = CoInitialize(NULL); under the main function.

Initialize COM objects

  1. Include the generated headers in your file and build the application.

Include the generated headers

GdViewer Integration in Visual C++ with MFC

This section provides you with a step-by-step guide to getting started creating a simple MFC application using GdPicture.NET with Visual C++ (up to VS 2017) and containing a GdViewer ActiveX component.

You can find an example using COM Interop in the [INSTALLATION FOLDER]\Samples\WinForm\c++ mfc folder.

Information

IntelliSense is fully supported in Visual C++.

Integration

  1. Start a new project in Visual Studio > File > New > Project. Then select Visual C++ > MFC/ATL > MFC Application. Write the project name and confirm.

Start a new project in Visual Studio

  1. Set your Application Type to Dialog based. Copy GdPicture.NET.14.(64).dll and GdPicture.NET.14.tlb to your application folder.

Set Application Type and copy files

  1. To import the installed GdPicture.NET toolkit (DLL) and to integrate the GdViewer control, you need to follow two steps.

To import as an ActiveX control:

  • Use Project > Class Wizard (available until VS 2017) and select the Add Class dropdown. Then, choose MFC Class From ActiveX Control… This is necessary for controls like GdViewer.

  • The window with the wizard will appear, and from the Available ActiveX controls list, choose GdPicture14.GdViewer.

Setting up in the Class Wizard

  • From the Interfaces list, choose IGdViewer and add it to the Generated classes list. Then click Finish and press OK.

Add IGdViewer to the Generated classes list

To import from TypeLib:

  • Use Project > Class Wizard (available until VS 2017) and select the Add Class dropdown. Then, choose MFC Class From TypeLib…

  • The window with the wizard will appear, and from the Available type libraries list, choose GdPicture14 - Document Imaging.

Choose GdPicture14 - Document Imaging from Available type libraries

  • From the Interfaces list, choose ILicenseManager and __GdViewer and add them to the Generated classes list. Then click Finish and press OK.

  1. Initialize COM objects in your application by adding HRESULT hr = CoInitialize(NULL); under the main function.

Initialize COM objects

Here’s the adapted source code:

BOOL CdemoApp::InitInstance()
 {
   ...
   InitCtrls.dwICC = ICC_WIN95_CLASSES;
   InitCommonControlsEx(&InitCtrls);

   CWinApp::InitInstance();
   HRESULT hr = CoInitialize(NULL);
   ...
 }
  1. Include the generated headers in your file and build the application.

Here’s the adapted source code:

// Add GdViewer control to the `demoDlg.h` file:
  class CdemoDlg : public CDialogEx
  {
  // Construction
  public:
      CGdViewer sampleView;
      ...
  }

  // Include headers in the `demoDlg.cpp` file:
  #include "C_GdViewer.h"
  #include "CLicenseManager.h"

Include the generated headers

Adding Code to Initialize the GdViewer Component

  1. Your default solution will look like what’s shown below. In Resource View, select Dialog/IDD_DEMO_DIALOG.

Solution Explorer

  1. When the form appears, choose Button from the toolbox on the left side and place it on the form.

  2. Double-click the form, and the method for the button click will appear.

  3. Update it with this code:

const int CTRL_ID = 280;
void CdemoDlg::OnBnClickedButton1()
 {
      // TODO: Add your control notification handler code here.
      CLicenseManager oLicenseManager;
      oLicenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
      oLicenseManager.RegisterKEY(L" XXX ");
      
      // Create the control, but make sure to use `WS_CHILD` and `WS_VISIBLE`.
      if (!sampleView.Create(L"PdfWnd", WS_CHILD | WS_VISIBLE, CRect(0, 0, 200, 200), this, CTRL_ID))
          {
            AfxMessageBox(L"Failed to create GdViewer control");
             return;
         }
      
      // Sample init settings — not necessary.
      sampleView.put_EnableMenu(false);
      sampleView.put_ContinuousViewMode(TRUE);
      sampleView.put_MouseWheelMode(2);
      sampleView.put_ScrollBars(TRUE);
      sampleView.DisplayFromFile(L"image.jpg");
      sampleView.Redraw();
}

Adding Code to Dispose of the GdViewer Component

The following example shows how you can release the GdViewer component. What’s important to note is that you need to dispose of the objects properly.

  1. Add a new method for handling the Close() message by choosing Resource View > Demo > Dialog > IDD_DEMO_DIALOG.

  2. Select the form that appears.

  3. Click the messages icon in the properties bar.

  4. Double-click the field next to WM_CLOSE. This will give you the option to create a method for handling Close() messages.

  5. Add the following code to the method you just created:

    • sampleView.CloseDocument();

    • sampleView.Dispose();

Adding code to dispose of the component

To handle the Close() message, use the following code:

// The result will look like this:
void CdemoDlg::OnClose()
{
    // TODO: Add your message handler code here and/or call default.
    CDialogEx::OnClose();
    sampleView.CloseDocument();
    sampleView.Dispose();
}

Integrate into Delphi and C++Builder

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Delphi and C++Builder

This section provides you with a step-by-step guide to getting started using GdPicture.NET with Delphi and C++Builder.

You can find two sample projects that demonstrate the use of GdPicture.NET features. These are located in the [INSTALLATION FOLDER]\Samples\WinForm\delphi folder and use COM Interop.

Information

IntelliSense is fully supported in Delphi and C++Builder.

Integration

You have two integration options, outlined below.

Importing as ActiveX Controls

  1. Start a new project in your Delphi environment and select Component > Import Component > Import ActiveX Control > Next.

Select Component > Import Component > Import ActiveX Control > Next

  1. Scroll through the list until you find GdPicture.NET 14 - Document Imaging SDK. Select it and click Next.

Select GdPicture.NET 14 - Document Imaging SDK and click Next

  1. In the Class Name(s) field, you’ll see all the classes available for import. Ensure Palette Page is set to ActiveX, and check that Unit Dir Name is how you want it. Select the Generate Component Wrappers checkbox and click Next. Then, select the Install to New Package option and click Next again.

Import Component

  1. Browse for the proper path and add it as the Package name. Then click Finish. Finally, add and confirm the framework by clicking Yes.

Add the package name and confirm

  1. Build the package. Change all instances of UIntPtr to Cardinal in the GdPicture_NET_14_TLB.pas file. After you’ve successfully built the package, you need to install it.

Build and install the package

  1. Finally, create your project, select your favorite components from the ActiveX palette, and use them in your application.

Select palettes

Information

  • Turn off floating-point exceptions.
  • In a Delphi 32-bit app, use `Set8087CW($133f);`.
  • In a Delphi 64-bit app, use `SetExceptionMask(exAllArithmeticExceptions);`. To use this, you first need to import the math runtime library.
  • In C++Builder, add `Set8087CW(0x133f);` to the `WTypes.h` file.

Example Use

The following code snippet demonstrates how to load a TIFF file and save it as a BMP:

procedure Test;
var TiffImageID, Status  : Integer;
begin
     LicenseManager1.RegisterKEY('XXX');    //Please, replace XXX by a valid demo or commercial KEY
     TiffImageID  := GdPictureImaging1.CreateGdPictureImageFromFile('d:\test.tif');
     Status := GdPictureImaging1.SaveAsBMP(TiffImageID, 'd:\output.bmp');
     if Status  <> 0 then
          MessageBox(0,Pchar('Error saving file. Status: ' + inttostr(Status)),'', 0)
     else
          MessageBox(0,Pchar('Done'),'', 0);
end;

Importing a Type Library

  1. Start a new project in your Delphi environment and select Component > Import Component… > Import a Type Library > Next.

Select Component > Import Component… > Import a Type Library > Next

  1. Scroll through the list until you find GdPicture.NET 14 - Document Imaging SDK. Select this and click Next.

Select GdPicture.NET 14 - Document Imaging SDK and click Next

  1. In the Class Name(s) field, you’ll see all the classes available for import. Check that Unit Dir Name is how you want it. Leave the Generate Component Wrappers checkbox empty, and then click Next. Then, select the Create Unit option and click Finish.

Import Component

  1. Include the generated unit in your files using the standard uses command, and build the application.

Include the unit and build the application

Example Use

The following code snippet demonstrates how to load a TIFF file and save it as a BMP:

procedure Test;
var
  LicenseManager1: Variant;
  GdPictureImaging1: _GdPictureImaging;
  TiffImageID  : Integer;
  Status: Integer;
begin
  LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
  LicenseManager1.RegisterKey('XXX');  //Please, replace XXX by a valid demo or commercial KEY
  GdPictureImaging1 := CreateComObject(CLASS_GdPictureImaging) as _GdPictureImaging;
  TiffImageID  := GdPictureImaging1.CreateGdPictureImageFromFile('d:\test.tif');
  Status := GdPictureImaging1.SaveAsBMP(TiffImageID, 'd:\output.bmp');
        if Status  <> 0 then
          MessageBox(0,Pchar('Error saving file. Status: ' + inttostr(Status)),'', 0)
        else
           MessageBox(0,Pchar('Done'),'', 0);
end;

Integrate into Microsoft Access

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Microsoft Access

Currently, we only provide examples in the [INSTALLATION FOLDER]\Samples\WinForm\msaccess folder using COM Interop .

Information

IntelliSense is fully supported in Microsoft Access.

If you want to resize GdPicture controls, here’s a helpful trick:

  • Use the menu at the top to insert an ActiveX control. Pick the GdPicture.NET user control. It’ll be the default size.

  • Then, select the lower-right corner and drag the size of the control to what you want. Save the form, close it, and then double-click to open it.

  • Be sure you also set the anchoring to the top-left corner of the control so Windows doesn’t try to resize it based on the form size.

Integrate into Visual FoxPro

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Visual FoxPro

Currently, we only provide examples in the [INSTALLATION FOLDER]\Samples\WinForm\vfp folder using COM Interop.

Information

IntelliSense is fully supported in Visual FoxPro.

We suggest adding the following line of code in the initialization of your program: application.AutoYield = .F.

Integrate into WinForms

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Adding GdPicture to Your Application

This section explains how to add GdPicture.NET to your application.

Adding a Reference to the NuGet Package

First, add a reference to the GdPicture.API NuGet package by following these steps:

  1. In Visual Studio, create a new project or open the code of your existing application. For more information on creating a new project, see the Microsoft documentation. It’s recommended to create a project that runs on .NET 6.0 or newer.

  2. Select Project > Manage NuGet Packages.

  3. In the Package source field, select nuget.org.

  4. Click the Browse tab, and then search for GdPicture.

  5. Select GdPicture, and then click Install.

Alternatively, add a reference to the GdPicture DLL file.

Importing GdPicture.NET to Your Application

Import GdPicture.NET to your application by referencing it in the beginning of all the code files where you use GdPicture.NET SDK:

using GdPicture14;
Imports GdPicture14;

For more information on the using directive in C#, see the Microsoft documentation.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Integrate into WPF

This guide explains how to integrate GdPicture.NET SDK into your application.

About GdPicture.NET SDK

GdPicture.NET SDK is a cross-platform developer solution for building intelligent PDF and document processing applications. This toolkit enables you to compose, display, capture, edit, and print documents. You can build applications using GdPicture.NET SDK with numerous development environments and deploy these applications to different platforms.

The diagram below displays how GdPicture.NET integrates into different platforms and development environments.

GdPicture.NET architecture diagram

Prerequisites

Before you follow the procedure in this guide, complete these steps:

  • Ensure you develop your application on a Windows machine. Currently, you can only develop applications using GdPicture.NET on Windows systems.

  • Install Visual Studio and the workloads or components that are necessary for the type of application you want to build. For more information, see the Microsoft documentation.

For more information on the supported frameworks and operating systems, see the system compatibility guide.

Installing GdPicture.NET SDK

Download the latest release

Once downloaded, follow the installation wizard, which will guide you through the installation process.

It’s recommended to install the toolkit at a destination such as C:\GdPicture.NET\.

Getting a Trial License Key

A trial license lets you try the GdPicture.NET software package for free for 60 days. This includes full access and technical support.

To get a trial license key, follow these steps:

  1. Go to the folder where you installed GdPicture.NET.

  2. Run licenseManager.exe.

  3. Click Request a trial key.

  4. Enter your email address and a password.

  5. Click Send Request. You’ll receive a trial license key by email.

Information

If you don’t immediately receive a key via email, or if the application can’t be run on a system that allows web requests, contact our Sales team.

Adding GdPicture to Your Application

This section explains how to add GdPicture.NET to your application.

Adding a Reference to the NuGet Package

First, add a reference to the GdPicture.API NuGet package by following these steps:

  1. In Visual Studio, create a new project or open the code of your existing application. For more information on creating a new project, see the Microsoft documentation. It’s recommended to create a project that runs on .NET 6.0 or newer.

  2. Select Project > Manage NuGet Packages.

  3. In the Package source field, select nuget.org.

  4. Click the Browse tab, and then search for GdPicture.

  5. Select GdPicture, and then click Install.

Alternatively, add a reference to the GdPicture DLL file.

Importing GdPicture.NET to Your Application

Import GdPicture.NET to your application by referencing it in the beginning of all the code files where you use GdPicture.NET SDK:

using GdPicture14;
Imports GdPicture14;

For more information on the using directive in C#, see the Microsoft documentation.

Activating the Trial License

To activate a trial license, follow these steps:

  1. In Visual Studio, create a LicenseManager object in the code file where the application loads before using any of the methods of GdPicture.NET.

  2. Pass the license key to the RegisterKEY method of the LicenseManager object.

  3. Repeat this process for all the code files where you use GdPicture.NET SDK.

LicenseManager licenseManager = new LicenseManager();
licenseManager.RegisterKEY("LICENSE_KEY");
Dim licenseManager As New LicenseManager
licenseManager.RegisterKEY("LICENSE_KEY")
CLicenseManager licenseManager;
licenseManager.CreateDispatch(L"GdPicture14.LicenseManager");
licenseManager.RegisterKEY(L"LICENSE_KEY");
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager(__uuidof(LicenseManager));
   VARIANT_BOOL result = licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
}
BSTR bstrLicense = ::SysAllocString(L"LICENSE_KEY");
if (bstrLicense != NULL)
{
   _LicenseManagerPtr licenseManager;
   licenseManager = (_LicenseManagerPtr)CreateComObject(CLSID_LicenseManager);
   licenseManager->RegisterKEY(bstrLicense);
   ::SysFreeString(bstrLicense);
   bstrLicense = NULL;
}
var
   LicenseManager1: Variant;
begin
   LicenseManager1 := CreateOleObject('GdPicture14.LicenseManager');
   LicenseManager1.RegisterKey('LICENSE_KEY');
var licenseManager;
licenseManager = new ActiveXObject("GdPicture14.LicenseManager");
licenseManager.RegisterKey("LICENSE_KEY");
long ll_result
OLEObject licenseManager
licenseManager = CREATE OLEObject
ll_result = licenseManager.ConnectToNewObject("GdPicture14.LicenseManager")
licenseManager.RegisterKey("LICENSE_KEY")
Dim licenseManager As New LicenseManager
Call licenseManager.RegisterKEY("LICENSE_KEY")
Dim licenseManager As New GdPicture_NET_14.LicenseManager
licenseManager.RegisterKey ("LICENSE_KEY")

This activates your trial license for 60 days. Once you purchase a commercial license, you might need to change this trial key. For more information on activating a commercial license, refer to our guide on activating GdPicture.NET for development.

Please select the build system you’re using:

Gradle Build System

  1. In your top-level build.gradle file, add the PSPDFKit Maven repository:

allprojects {
	repositories {
		maven {
				url 'https://customers.pspdfkit.com/maven/'
		}
	}
}
  1. In the depending module’s build.gradle file, add the PSPDFKit dependency:

    dependencies {
        implementation 'com.pspdfkit:libraries-java:1.4.1'
    }
  2. Add the OCR dependency (optional). This is only necessary if you plan to use the OCR feature.

To use the PSPDFKit OCR feature with the PSPDFKit Java Library, a separate package, libraries-java-ocr, is required.

Add the new package dependency to your build.gradle file:

dependencies {
...
    implementation 'com.pspdfkit:libraries-java-ocr:1.4.1'
}

Maven Build System

  1. In your top-level pom.xml file, add the PSPDFKit Maven repository:

<repositories>
	<repository>
		<id>pspdfkit</id>
		<name>PSPDFKit Maven</name>
		<url>https://customers.pspdfkit.com/maven/</url>
	</repository>
</repositories>
  1. In the depending module’s pom.xml file, add the PSPDFKit dependency:

<dependencies>
	<dependency>
		<groupId>com.pspdfkit</groupId>
		<artifactId>libraries-java</artifactId>
		<version>1.4.1</version>
	</dependency>
</dependencies>
  1. Add the OCR dependency (optional). This is only necessary if you plan to use the OCR feature.

To use the PSPDFKit OCR feature with the PSPDFKit Java Library, a separate package, libraries-java-ocr, is required.

Add the new package dependency to your project pom.xml file:

<dependencies>
    ...
    <dependency>
        <groupId>com.pspdfkit</groupId>
        <artifactId>libraries-java-ocr</artifactId>
        <version>1.4.1</version>
    </dependency>

Using the PSPDFKit Java Library

  1. Now that the PSPDFKit Java Library is added, you can use the SDK in your application. You need to initialize the SDK prior to calling any other PSPDFKit method. Use the initializeTrial method if you haven’t yet bought a license key, or the initialize method if you have a key:

public void initializePSPDFKit() throws PSPDFKitInitializeException {
    PSPDFKit.initializeTrial();
}
@Throws(PSPDFKitInitializeException::class)
fun initializePSPDFKit() : Void {
    PSPDFKit.initializeTrial();
}
  1. Load a document with:

File file = new File("path/to/document.pdf");
PdfDocument document = PdfDocument.open(new FileDataProvider(file));
val file = File("path/to/document.pdf")
val document = PdfDocument.open(FileDataProvider(file))
  1. Once you have a document loaded, you can use the rest of the library. See the API docs and guides for more information, or try out the Catalog examples (see below).

Building and Running the Catalog App

The PSPDFKit Java Library comes with an example application called the Catalog app, which contains many useful examples for exploring the different features of PSPDFKit and getting started quickly. You can find the app in the Example folder of the SDK ZIP file.

To build and run the Catalog app, follow these steps.

  1. Download the latest release.

  2. Extract PSPDFKit-Libraries-java_binary-{version}.zip to your desired location and cd into the root of its directory.

  3. cd into the Catalog (cd catalog).

  4. Build and run the Catalog application:

./gradlew runJava

The PSPDFKit Java Library comes with an example application called the Catalog app, which contains many useful examples for exploring the different features of PSPDFKit and getting started quickly. You can find the app in the Example folder of the SDK ZIP file.

To build and run the Catalog app, follow these steps.

  1. Download the latest release.

  2. Extract PSPDFKit-Libraries-java_binary-{version}.zip to your desired location and cd into the root of its directory.

  3. cd into the Catalog (cd catalog).

  4. Build and run the Catalog application:

./gradlew runJava

The PSPDFKit Java Library comes with an example application called the Catalog app, which contains many useful examples for exploring the different features of PSPDFKit and getting started quickly. You can find the app in the Example folder of the SDK ZIP file.

To build and run the Catalog app, follow these steps.

  1. Download the latest release.

  2. Extract PSPDFKit-Libraries-java_binary-{version}.zip to your desired location and cd into the root of its directory.

  3. cd into the Catalog (cd catalog).

  4. Build and run the Catalog application:

gradlew.bat runJava

Only use the manual method if absolutely necessary. Otherwise, please refer to the main Integrating PSPDFKit Java Library guide for more details.

Please select the build system you’re using:

Gradle Build System

If you’re using the Gradle build system, a good example of how to integrate the PSPDFKit Java Library can be seen in the Catalog example distributed in the downloaded ZIP.

Complete the following steps for manual Gradle integration.

  1. Create a folder within your project named libs.

  2. Download the latest release.

  3. In the downloaded ZIP file, there will be a JAR file, pspdfkit-1.4.1.jar. Copy this JAR file into the libs folder you just created.

  4. In your project’s build.gradle folder, add a dependency to the copied JAR file (replace the wildcards with the version number):

dependencies {
	...
	implementation files('libs/pspdfkit-1.4.1.jar')

	// Required by PSPDFKit.
	implementation 'org.json:json:20180813'
	implementation 'org.apache.httpcomponents:httpclient:4.5.9'
	...
}

Now your Gradle project will depend upon the PSPDFKit JAR. More information about declaring dependencies can be found in the Gradle documentation.

  1. Add the OCR dependency (optional). This is only necessary if you plan to use the OCR feature.

To use the PSPDFKit OCR feature with the PSPDFKit Java Library, a separate package, libraries-java-ocr, is required.

Maven Build System

To use the PSPDFKit Java Library with Maven, it’s first necessary to install the PSPDFKit JAR to a Maven repository. Only when this is done can it be a reference for a Maven project.

  1. Download the latest release.

  2. Extract the files from PSPDFKit-Java-binary-1.4.1.zip into a known location.

  3. Within your project, using mvn on the command line, add the PSPDFKit JAR to a repository, replacing both the version (where necessary) and the path to the JAR and POM (extracted from PSPDFKit-Java-binary-1.4.1.zip):

mvn install:install-file -Dfile=/path/to/jar/pspdfkit-*.*.*.jar -DpomFile=/path/to/pom/pspdfkit-pom.xml

This will install the JAR to a local repository. It’s also possible to publish this JAR remotely; please see the Maven guides if this is a requirement.

  1. Add the PSPDFKit Java Library as a dependency of your project. In your project’s pom.xml, add the following, replacing the version with the target version:

...
<dependencies>
	<dependency>
		<groupId>com.pspdfkit.api</groupId>
		<artifactId>pspdfkit</artifactId>
		<version>1.4.1</version>
	</dependency>
</dependencies>
...

Now your Maven project will depend on the PSPDFKit JAR published to the chosen repository.

  1. Add the OCR dependency (optional). This is only necessary if you plan to use the OCR feature.

To use the PSPDFKit OCR feature with the PSPDFKit Java Library, a separate package, libraries-java-ocr, is required.

Using the PSPDFKit Java Library

  1. Now that the PSPDFKit Java Library is added, you can use the SDK in your application. You need to initialize the SDK prior to calling any other PSPDFKit method. Use the initializeTrial method if you haven’t yet bought a license key, or the initialize method if you have a key:

public void initializePSPDFKit() throws PSPDFKitInitializeException {
    PSPDFKit.initializeTrial();
}
@Throws(PSPDFKitInitializeException::class)
fun initializePSPDFKit() : Void {
    PSPDFKit.initializeTrial();
}
  1. Load a document with:

File file = new File("path/to/document.pdf");
PdfDocument document = PdfDocument.open(new FileDataProvider(file));
val file = File("path/to/document.pdf")
val document = PdfDocument.open(FileDataProvider(file))
  1. Once you have a document loaded, you can use the rest of the library. See the API docs and guides for more information, or try out the Catalog examples (see below).

Building and Running the Catalog App

The PSPDFKit Java Library comes with an example application called the Catalog app, which contains many useful examples for exploring the different features of PSPDFKit and getting started quickly. You can find the app in the Example folder of the SDK ZIP file.

To build and run the Catalog app, follow these steps.

  1. Download the latest release.

  2. Extract PSPDFKit-Libraries-java_binary-{version}.zip to your desired location and cd into the root of its directory.

  3. cd into the Catalog (cd catalog).

  4. Build and run the Catalog application:

./gradlew runJava

The PSPDFKit Java Library comes with an example application called the Catalog app, which contains many useful examples for exploring the different features of PSPDFKit and getting started quickly. You can find the app in the Example folder of the SDK ZIP file.

To build and run the Catalog app, follow these steps.

  1. Download the latest release.

  2. Extract PSPDFKit-Libraries-java_binary-{version}.zip to your desired location and cd into the root of its directory.

  3. cd into the Catalog (cd catalog).

  4. Build and run the Catalog application:

./gradlew runJava

The PSPDFKit Java Library comes with an example application called the Catalog app, which contains many useful examples for exploring the different features of PSPDFKit and getting started quickly. You can find the app in the Example folder of the SDK ZIP file.

To build and run the Catalog app, follow these steps.

  1. Download the latest release.

  2. Extract PSPDFKit-Libraries-java_binary-{version}.zip to your desired location and cd into the root of its directory.

  3. cd into the Catalog (cd catalog).

  4. Build and run the Catalog application:

gradlew.bat runJava

This guide walks you through the steps necessary to start PSPDFKit Processor. It also shows you how to use it to process documents. By the end, you’ll be able to merge two PDF documents into one using Processor’s HTTP API from PHP.

Requirements

PSPDFKit Processor runs on a variety of platforms. The following operating systems are supported:

  • macOS Ventura, Monterey, Mojave, Catalina, or Big Sur

  • Windows 10 Pro, Home, Education, or Enterprise 64-bit

  • Ubuntu, Fedora, Debian, or CentOS. Ubuntu and Debian derivatives such as Kubuntu or Xubuntu are supported as well. Currently only 64-bit Intel (x86_64) processors are supported.

Regardless of your operating system, you’ll need at least 4 GB of RAM.

Installing Docker

PSPDFKit Processor is distributed as a Docker container. To run it on your computer, you need to install a Docker runtime distribution for your operating system.

Install and start Docker Desktop for Mac. Please refer to the Docker website for instructions.

Install and start Docker Desktop for Windows. Please refer to the Docker website for instructions.

Install and start Docker Engine. Please refer to the Docker website for instructions on how to install it for your Linux distribution.

After you install Docker, use these instructions to install Docker Compose.

Starting PSPDFKit Processor

First, open your terminal emulator.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use Terminal.app or iTerm2.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use PowerShell.

Use the terminal emulator integrated with your code editor or IDE, or one bundled with your desktop environment.

Now run the following command:

docker run --rm -t -p 5000:5000 pspdfkit/processor:2023.5.0

This command might take a while to run, depending on your internet connection speed. Wait until you see a message like this in the terminal:

[info]  2023-02-05 18:56:45.286  Running PSPDFKit Processor version 2023.5.0. pid=<0.1851.0>

The PSPDFKit Processor is now up and running!

Installing PHP

The interaction with Processor happens via its HTTP API: You send documents and commands in the request and receive the resulting file in the response. To do this, you’ll invoke the API from the PHP script. But first, you need to install PHP for your operating system:

The easiest way to install PHP on macOS is via Homebrew. Follow the instructions on the Homebrew website to install it. Then, to install PHP, run:

brew install php@7.4 && brew link php@7.4

Verify the installation by running the following command in the terminal:

php --version

The output should start with PHP 7.4 — you can ignore the rest of the message.

ℹ️ Note: If the output doesn’t match the above, try restarting your terminal app by typing exit and opening it again.

  1. Download the PHP ZIP archive from the PHP website (pick the x86 Thread Safe build of the 7.4 release).

  2. Create a folder anywhere on your C: drive.

  3. Extract the ZIP archive into the folder you just created.

  4. Open the terminal and switch to that folder:

cd C:\path\to\directory

Now run the .\php.exe --version command. The output should start with PHP 7.4 — you can ignore the rest of the message.

To proceed, you’ll also need to create a PHP configuration file to enable a specific extension. So in the same directory, create a php.ini file with the following content:

[PHP]
extension=curl

Save the file, as you’ll need it shortly.

You can install PHP using your distribution’s package manager:

apt-get update && apt-get install -y php
dnf install -y php

Now run the php --version command. The output should start with PHP 7.4 — you can ignore the rest of the message.

Handling File Uploads

In this example project, the PDF files you’ll merge will be uploaded through a simple webpage via a standard HTML form. Create a file called index.php with the following content:

<!DOCTYPE html>
<html>
<head>
    <title>Merge PDFs with PSPDFKit Processor</title>
</head>
<body>
    <p>Upload the files to merge:</p>
    <form enctype="multipart/form-data" action="merge.php" method="post">
        <div>File 1: <input name="file1" type="file" accept="application/pdf"></div>
        <div>File 2: <input name="file2" type="file" accept="application/pdf"></div>
        <input type="submit" value= "Merge PDFs">
    </form>
</body>
</html>

Now open the terminal and type the following command in the same directory where you created the index.php file:

php -S localhost:8000
.\php.exe -c php.ini -S localhost:8000
php -S localhost:8000

Go to http://localhost:8000 in the browser. You should see a webpage similar to this:

A webpage with a form with two file inputs

When you choose files and click the Merge PDFs button, you’ll receive an error. This is because you haven’t yet written any code to handle the form submission.

Create a merge.php file in the same directory and add the following content to it:

<?php
$file1 = $_FILES['file1'];
$file2 = $_FILES['file2'];

echo $file1['name'], ", ", $file2['name'];
?>

Now when you go back to http://localhost:8000, choose the files, and submit the form, you should see the names of the files you picked printed on the screen:

A webpage with two file names

Merging PDFs

You can now use Processor’s API to merge the files uploaded from the browser. Replace the contents of the merge.php file with:

<?php
$file1 = $_FILES["file1"];
$file2 = $_FILES["file2"];

$headers = ["Content-Type" => "multipart/form-data"];
$postFields = [];
$postFields["document1"] = curl_file_create(
    $file1["tmp_name"],
    $file1["type"],
    $file1["name"]
);

$postFields["document2"] = curl_file_create(
    $file2["tmp_name"],
    $file2["type"],
    $file2["name"]
);

$postFields["instructions"] = json_encode([
    "parts" => [
        [
            "file" => "document1"
        ],
        [
            "file" => "document2"
        ]
    ],
]);

$request = curl_init();
curl_setopt($request, CURLOPT_URL, "http://localhost:5000/build");
curl_setopt($request, CURLOPT_HTTPHEADER, $headers);
curl_setopt($request, CURLOPT_POST, true);
curl_setopt($request, CURLOPT_POSTFIELDS, $postFields);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($request);

$status = curl_getinfo($request, CURLINFO_RESPONSE_CODE);
$file_size = curl_getinfo($request, CURLINFO_CONTENT_LENGTH_DOWNLOAD);
curl_close($request);

if ($status != 200) {
    echo "Request to Processor failed with status code " .
        $status .
        ': "' .
        $response .
        '".';
} else {
    header("Content-type: application/pdf");
    header('Content-Disposition: attachment; filename="result.pdf"');
    header("Content-Transfer-Encoding: binary");
    header("Content-Length: " . $file_size);
    header("Accept-Ranges: bytes");
    echo $response;
}

Most of this code, up until the curl_exec function, constructs a request that’s sent to PSPDFKit Processor. It includes two files — document1 and document2 — and a list of instructions for Processor. By default, Processor’s output (the /build endpoint) is the result of merging all documents or parts of the instructions. To learn more about the /build instructions, go to Processor’s API Reference.

The rest of the code deals with error handling, and if everything goes well, it returns the resulting file back to the browser.

You can check how it works in practice yourself! Go to http://localhost:8000, pick any two PDFs on your disk (or use these two if you don’t have any: file1.pdf, file2.pdf), and click Merge PDFs again. Depending on your browser, it will either automatically download the file for you or ask you for permission to download. In any case, look for the result.pdf file in the downloads folder on your computer. Open that file in any PDF viewer application. If you used the two files from the links above, you should see a five-page PDF document like this:

The result merging document with a cover page

That’s it! Now you know how to use Processor from PHP to perform operations on documents.

This guide walks you through the steps necessary to start PSPDFKit Processor. It also shows you how to use it to process documents. By the end, you’ll be able to merge two PDF documents into one using Processor’s HTTP API from Python.

Requirements

PSPDFKit Processor runs on a variety of platforms. The following operating systems are supported:

  • macOS Ventura, Monterey, Mojave, Catalina, or Big Sur

  • Windows 10 Pro, Home, Education, or Enterprise 64-bit

  • Ubuntu, Fedora, Debian, or CentOS. Ubuntu and Debian derivatives such as Kubuntu or Xubuntu are supported as well. Currently only 64-bit Intel (x86_64) processors are supported.

Regardless of your operating system, you’ll need at least 4 GB of RAM.

Installing Docker

PSPDFKit Processor is distributed as a Docker container. To run it on your computer, you need to install a Docker runtime distribution for your operating system.

Install and start Docker Desktop for Mac. Please refer to the Docker website for instructions.

Install and start Docker Desktop for Windows. Please refer to the Docker website for instructions.

Install and start Docker Engine. Please refer to the Docker website for instructions on how to install it for your Linux distribution.

After you install Docker, use these instructions to install Docker Compose.

Starting PSPDFKit Processor

First, open your terminal emulator.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use Terminal.app or iTerm2.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use PowerShell.

Use the terminal emulator integrated with your code editor or IDE, or one bundled with your desktop environment.

Now run the following command:

docker run --rm -t -p 5000:5000 pspdfkit/processor:2023.5.0

This command might take a while to run, depending on your internet connection speed. Wait until you see a message like this in the terminal:

[info]  2023-02-05 18:56:45.286  Running PSPDFKit Processor version 2023.5.0. pid=<0.1851.0>

The PSPDFKit Processor is now up and running!

Installing Python

The interaction with Processor happens via its HTTP API: You send documents and commands in the request and receive the resulting file in the response. To do this, you’ll invoke the API from the Python script. But first, you need to install Python for your operating system:

To install Python, first you need to install the Xcode Command Line Tools. Install them by running the following command:

xcode-select --install

The easiest way to install Python on macOS is via Homebrew. Follow the instructions on the Homebrew website to install it. Then, to install Python, run:

brew install python

Verify the installation by running the following command in the terminal:

python3 --version

The output should start with Python 3.9 — you can ignore the rest of the message.

ℹ️ Note: ️If the output doesn’t match the above, try restarting the terminal app by typing exit and opening it again.

  1. Go to the Python downloads website.

  2. Scroll down to the bottom of the page until you find the Windows installer (64-bit) entry. Click on the link to download the installer.

  3. Open the installer. Make sure to check the Add Python 3.9 to PATH checkbox at the bottom of the window, and click Install Now.

  4. Complete the installation process.

Now start the terminal and run the python --version command. The output should start with Python 3.9 — you can ignore the rest of the message.

You can install Python using your distribution’s package manager:

apt-get update && apt-get install -y python3.9 python3-pip && ln -s /usr/bin/python3.9 /usr/bin/python3
dnf install -y python3 python3-pip

Now run the python3 --version command. The output should start with Python 3.9 — you can ignore the rest of the message.

Merging PDFs

To make HTTP requests to Processor’s API, you need an HTTP client library. For this scenario, you’ll use the excellent Requests package. Install it by running the following command:

python3 -m pip install requests==2.25.1
python -m pip install requests==2.25.1
python3 -m pip install requests==2.25.1

Now you can create a script to merge the PDFs. It’ll take two file paths as command-line arguments, send the files to Processor to merge them, and save the result in another file on disk. Create a merge.py file with the following content:

import sys
import json
import requests

if len(sys.argv) < 3:
    print("Too few arguments.")
    exit(1)

file1 = sys.argv[1]
file2 = sys.argv[2]

url = "http://localhost:5000/build"

payload= {
    "instructions": json.dumps({
        "parts": [
            {
                "file": "file1"
            },
            {
                "file": "file2"
            }
        ]
})}

files=[
  ('file1',('file1.pdf',open(file1,'rb'),'application/pdf')),
  ('file2',('file2.pdf',open(file2,'rb'),'application/pdf'))
]
headers = {}

response = requests.post(url, data=payload, files=files)

if response.status_code == 200:
    with open("result.pdf", "wb") as f:
        f.write(response.content)
else:
    print(
        f"Request to Processor failed with status code {response.status_code}: '{response.text}'."
    )

The script verifies that the number of arguments is correct and prepares the request data. It includes two files — file1 and file2 — and a list of instructions for Processor. By default, Processor’s output (the /build endpoint) is the result of merging all documents or parts of the instructions. To learn more about the /build instructions, go to Processor’s API Reference.

The rest of the code deals with error handling, and if everything goes well, it saves the result in the result.pdf file in the current working directory.

You can check how it works in practice yourself! Pick any two PDFs on your computer (or use these two if you don’t have any: file1.pdf, file2.pdf), and run the script:

python3 merge.py path/to/file1.pdf path/to/file2.pdf
python merge.py path/to/file1.pdf path/to/file2.pdf
python3 merge.py path/to/file1.pdf path/to/file2.pdf

Make sure to replace path/to/file1.pdf and path/to/file2.pdf with the actual location of the PDF files on your computer.

If you used the two files from the links above, you should see a five-page PDF document like this:

The result merging document with a cover page

That’s it! Now you know how to use Processor from Python to perform operations on documents.

This guide walks you through the steps necessary to start PSPDFKit Processor. It also shows you how to use it to process documents. By the end, you’ll be able to merge two PDF documents into one using Processor’s HTTP API from Rust.

Requirements

PSPDFKit Processor runs on a variety of platforms. The following operating systems are supported:

  • macOS Ventura, Monterey, Mojave, Catalina, or Big Sur

  • Windows 10 Pro, Home, Education, or Enterprise 64-bit

  • Ubuntu, Fedora, Debian, or CentOS. Ubuntu and Debian derivatives such as Kubuntu or Xubuntu are supported as well. Currently only 64-bit Intel (x86_64) processors are supported.

Regardless of your operating system, you’ll need at least 4 GB of RAM.

Installing Docker

PSPDFKit Processor is distributed as a Docker container. To run it on your computer, you need to install a Docker runtime distribution for your operating system.

Install and start Docker Desktop for Mac. Please refer to the Docker website for instructions.

Install and start Docker Desktop for Windows. Please refer to the Docker website for instructions.

Install and start Docker Engine. Please refer to the Docker website for instructions on how to install it for your Linux distribution.

After you install Docker, use these instructions to install Docker Compose.

Starting PSPDFKit Processor

First, open your terminal emulator.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use Terminal.app or iTerm2.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use PowerShell.

Use the terminal emulator integrated with your code editor or IDE, or one bundled with your desktop environment.

Now run the following command:

docker run --rm -t -p 5000:5000 pspdfkit/processor:2023.5.0

This command might take a while to run, depending on your internet connection speed. Wait until you see a message like this in the terminal:

[info]  2023-02-05 18:56:45.286  Running PSPDFKit Processor version 2023.5.0. pid=<0.1851.0>

The PSPDFKit Processor is now up and running!

Installing Rust

The interaction with PSPDFKit Processor happens via its HTTP API. Documents and commands are sent in API request calls, and the resulting files are received in API response calls. API calls are invoked from the Rust code, so you need to install Rust.

To install Rust:

  1. Follow the instructions for your operating system in Rust’s Installation Guide.

  2. Go to any directory in your system using your terminal. Create a new directory called merging-pdfs and go the newly created directory:

mkdir merging-pdfs
cd merging-pdfs
  1. Create a new cargo project:

cargo new merging-pdfs-pspdfkit
  1. Run the project with the cargo run command.

Merging PDFs with Rust

If you don’t have any sample documents, download and use these files: cover.pdf and document.pdf

Paste the following content into the Cargo.toml file in the merging-pdfs-pspdfkit project directory:

[dependencies]
tokio = { version = "1.23.0", features = ["full"] }
reqwest = { version = "0.11.13", features = ["json", "multipart"] }
serde_json = "1.0.91"

Next, replace /path/to/cover.pdf on line 24 and /path/to/document.pdf on line 30 with the actual paths to the example documents on your machine. Then, replace the contents of the src/main.rs file with this code:

use reqwest::Result;
use std::borrow::Cow;
use std::fs;
use std::fs::File;
use std::io::Write;

#[tokio::main]
async fn main() -> Result<()> {
    // Multipart Request
    let body = serde_json::json!({
        "parts": [
            {
                "file": "cover"
            },
            {
                "file": "document"
            }
        ],
        "output": {
            "type": "pdf"
        }
    });

    let cover = fs::read("src/cover.pdf").unwrap();
    let cover_part = reqwest::multipart::Part::bytes(cover)
        .file_name("cover.pdf")
        .mime_str("application/pdf")
        .unwrap();

    let document = fs::read("src/document.pdf").unwrap();
    let document_part = reqwest::multipart::Part::bytes(document)
        .file_name("document.pdf")
        .mime_str("application/pdf")
        .unwrap();

    let instructions = serde_json::to_vec(&body).unwrap();
    let instructions_bytes = Cow::from(instructions);
    let instructions_part = reqwest::multipart::Part::bytes(instructions_bytes);


    let form = reqwest::multipart::Form::new()
        .part("cover", cover_part)
        .part("document", document_part)
        .part("instructions", instructions_part);

    let client = reqwest::Client::new();
    let res = client
        .post("http://localhost:5000/build")
        .multipart(form)
        .send()
        .await?;

    let mut result_file = File::create("result.pdf").expect("Error creating file");

    result_file
        .write_all(&res.bytes().await.unwrap())
        .expect("Error writing to file");

    Ok(())
}

Most of this code deals with creating and sending a multipart request containing files and instructions to Processor’s /build endpoint using Rust’s reqwest crate.

To run the code, ensure you’re in the merging-pdfs directory and type the following command in your terminal:

cargo run
The result is a merged document with a cover page

To learn more about the various actions you can apply to PDFs using PSPDFKit Processor, go to Processor’s API Reference.

This guide walks you through the steps necessary to start PSPDFKit Processor. It also shows you how to use it to process documents. By the end, you’ll be able to merge two PDF documents into one using Processor’s HTTP API with Golang.

Requirements

PSPDFKit Processor runs on a variety of platforms. The following operating systems are supported:

  • macOS Ventura, Monterey, Mojave, Catalina, or Big Sur

  • Windows 10 Pro, Home, Education, or Enterprise 64-bit

  • Ubuntu, Fedora, Debian, or CentOS. Ubuntu and Debian derivatives such as Kubuntu or Xubuntu are supported as well. Currently only 64-bit Intel (x86_64) processors are supported.

Regardless of your operating system, you’ll need at least 4 GB of RAM.

Installing Docker

PSPDFKit Processor is distributed as a Docker container. To run it on your computer, you need to install a Docker runtime distribution for your operating system.

Install and start Docker Desktop for Mac. Please refer to the Docker website for instructions.

Install and start Docker Desktop for Windows. Please refer to the Docker website for instructions.

Install and start Docker Engine. Please refer to the Docker website for instructions on how to install it for your Linux distribution.

After you install Docker, use these instructions to install Docker Compose.

Starting PSPDFKit Processor

First, open your terminal emulator.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use Terminal.app or iTerm2.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use PowerShell.

Use the terminal emulator integrated with your code editor or IDE, or one bundled with your desktop environment.

Now run the following command:

docker run --rm -t -p 5000:5000 pspdfkit/processor:2023.5.0

This command might take a while to run, depending on your internet connection speed. Wait until you see a message like this in the terminal:

[info]  2023-02-05 18:56:45.286  Running PSPDFKit Processor version 2023.5.0. pid=<0.1851.0>

The PSPDFKit Processor is now up and running!

Installing Golang

The interaction with PSPDFKit Processor happens via its HTTP API. Documents and commands are sent in API request calls, and the resulting files are received in API response calls. API calls are invoked from the Go package, so you need to install Golang.

To install Golang:

  1. Follow the instructions for your operating system on Golang’s Download and Installation Page.

  2. Go to any directory in your system using your terminal. Create a new directory called merging-pdfs and go to the newly created directory:

mkdir merging-pdfs
cd merging-pdfs
  1. Create a new go module by running the command below from the merging-pdfs directory. Replace YOUR-GITHUB-USERNAME with your actual GitHub username:

go mod init github.com/YOUR-GITHUB-USERNAME/merging-pdfs
  1. Create a new file in the directory called merge.go and add the following content:

package main

import "fmt"

func main() {
  fmt.Println("Hello World")
}
  1. Run the file from your terminal with go run merge.go to make sure everything is working properly.

Merging PDFs with Golang

If you don’t have any sample documents, download and use these files: cover.pdf and document.pdf

Replace the contents of the merge.go file with the code below. Replace /path/to/cover.pdf in lines 37 and 46, and replace /path/to/document.pdf in lines 59 and 68 with the actual paths to the example documents on your machine:

package main

import (
	"bytes"
	"fmt"
	"io"
	"log"
	"mime/multipart"
	"net/http"
	"os"
	"path/filepath"
)

func main() {
	instructions := `
		{
			"parts": [
				{
					"file": "cover"
				},
				{
					"file": "document"
				}
			]
		}
	`

	payload := &bytes.Buffer{}
	writer := multipart.NewWriter(payload)

	err := writer.WriteField("instructions", instructions)
	if err != nil {
		log.Fatalln(err)
	}

	// Replace "/path/to/cover.pdf".
	cover, err := os.Open("/path/to/cover.pdf")
	defer cover.Close()

	if err != nil {
		log.Fatalln(err)
		return
	}
	
	// Replace "/path/to/cover.pdf".
	coverPart, err := writer.CreateFormFile("cover", filepath.Base("/path/to/cover.pdf"))
	if err != nil {
		log.Fatalln(err)
		return
	}

	_, err = io.Copy(coverPart, cover)
	if err != nil {
		log.Fatalln(err)
		return
	}

	// Replace "/path/to/document.pdf".
	document, err := os.Open("/path/to/document.pdf")
	defer document.Close()

	if err != nil {
		log.Fatalln(err)
		return
	}

	// Replace "/path/to/document.pdf".
	documentPart, err := writer.CreateFormFile("document", filepath.Base("/path/to/document.pdf"))
	if err != nil {
		log.Fatalln(err)
		return
	}

	_, err = io.Copy(documentPart, document)
	if err != nil {
		log.Fatalln(err)
		return
	}

	err = writer.Close()
	if err != nil {
		fmt.Println(err)
		return
	}

	processorUrl := "http://localhost:5000/build"
	method := "POST"

	client := &http.Client{}
	req, err := http.NewRequest(method, processorUrl, payload)

	if err != nil {
		fmt.Println(err)
		return
	}
	req.Header.Set("Content-Type", writer.FormDataContentType())
	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	output, err := os.Create("result.pdf")

	log.Print(res)
	output.ReadFrom(res.Body)

	if err != nil {
		fmt.Println(err)
		return
	}
}

To run the code, ensure you’re in the merging-pdfs directory and type the following command in your terminal:

go run merge.go

Most of this code, up until the client.Do(req) statement, constructs a multipart request that’s sent to Processor. It includes two files — in this case, cover and document — and a list of instructions for PSPDFKit Processor.

By default, PSPDFKit Processor’s output (the /build endpoint) is the result of merging all input documents or parts of the instructions.

To learn more about the /build instructions, go to the Processor API Reference article.

The result of this code is a merged result.pdf file in the merging-pdfs directory.

The result is a merged document with a cover page

This guide walks you through the steps necessary to start PSPDFKit Processor. It also shows you how to use it to process documents. By the end, you’ll be able to merge two PDF documents into one using Processor’s HTTP API via curl.

Requirements

PSPDFKit Processor runs on a variety of platforms. The following operating systems are supported:

  • macOS Ventura, Monterey, Mojave, Catalina, or Big Sur

  • Windows 10 Pro, Home, Education, or Enterprise 64-bit

  • Ubuntu, Fedora, Debian, or CentOS. Ubuntu and Debian derivatives such as Kubuntu or Xubuntu are supported as well. Currently only 64-bit Intel (x86_64) processors are supported.

Regardless of your operating system, you’ll need at least 4 GB of RAM.

Installing Docker

PSPDFKit Processor is distributed as a Docker container. To run it on your computer, you need to install a Docker runtime distribution for your operating system.

Install and start Docker Desktop for Mac. Please refer to the Docker website for instructions.

Install and start Docker Desktop for Windows. Please refer to the Docker website for instructions.

Install and start Docker Engine. Please refer to the Docker website for instructions on how to install it for your Linux distribution.

After you install Docker, use these instructions to install Docker Compose.

Starting PSPDFKit Processor

First, open your terminal emulator.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use Terminal.app or iTerm2.

Use the terminal emulator integrated with your code editor or IDE. Alternatively, you can use PowerShell.

Use the terminal emulator integrated with your code editor or IDE, or one bundled with your desktop environment.

Now run the following command:

docker run --rm -t -p 5000:5000 pspdfkit/processor:2023.5.0

This command might take a while to run, depending on your internet connection speed. Wait until you see a message like this in the terminal:

[info]  2023-02-05 18:56:45.286  Running PSPDFKit Processor version 2023.5.0. pid=<0.1851.0>

The PSPDFKit Processor is now up and running!

Installing curl

The interaction with Processor happens via its HTTP API: You send documents and commands in the request and receive the resulting file in the response. To do this, you’ll first install curl so that it can call the API.

curl is bundled with macOS, so there are no extra steps you need to take to install it.

  1. Go to the curl website and download the curl for 64 bit package.

  2. Create a folder anywhere on your C: drive. Unzip the downloaded package and copy the curl.exe executable from the bin subfolder into the folder you just created.

  3. Open the terminal and switch to the directory where you placed the curl executable:

cd C:\path\to\directory

Now run the .\curl.exe --version command. The output should start with curl 7 — you can ignore the rest of the message.

curl is bundled with most desktop Linux distributions. You can check if it’s installed by running the curl --version command in the terminal. If you get an error, you can install it using your distribution’s package manager:

apt-get update && apt-get install -y curl
dnf install -y curl

Now run the curl --version command. The output should start with curl 7 — you can ignore the rest of the message.

Merging PDFs

Now that everything is set up, you can start using Processor to merge PDFs. More specifically, you’ll add a cover page to the existing document.

  1. (Optional) If you don’t have any sample documents, download and use these files: cover.pdf and document.pdf.

  2. Move both files to the same directory (if you’re running on Windows, use the same folder where you placed the curl.exe executable).

  3. Run the command below.

When merging documents, the order of the instruction parts reflects the order you want the final document to be in. In this example, the cover page comes before the rest of the document in the final merged output. This means that the instructions for the /build request reflect the parts in that order.

curl -X POST http://localhost:5000/build \
  -F document=@document.pdf \
  -F 'cover-page=@cover.pdf;type=application/pdf' \
  -F instructions='{
  "parts": [
    {
      "file": "cover-page"
    },
    {
      "file": "document"
    }
  ]
}' \
  -o result.pdf
curl.exe -X POST http://localhost:5000/build `
  -F document=@document.pdf `
  -F 'cover-page=@cover.pdf;type=application/pdf' `
  -F instructions='{
  ""parts"": [
    {
      ""file"": ""cover-page""
    },
    {
      ""file"": ""document""
    }
  ]
}' `
  -o result.pdf
curl -X POST http://localhost:5000/build \
  -F document=@document.pdf \
  -F 'cover-page=@cover.pdf;type=application/pdf' \
  -F instructions='{
  "parts": [
    {
      "file": "cover-page"
    },
    {
      "file": "document"
    }
  ]
}' \
  -o result.pdf

Open the result.pdf file in any PDF viewer — you’ll see a five-page PDF document like what’s shown below.

The result is a merged document with a cover page

To learn more about the actions you can perform on documents with PSPDFKit Processor’s /build endpoint, go to our API Reference.