Pdftools

https://www.pdf-tools.com/docs/
Admin
Pdftools offers a comprehensive suite of SDKs and tools for converting, creating, modifying,...
Tokens:931,185
Snippets:4,851
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Started with Conversion Service

Source: https://www.pdf-tools.com/docs/llms

Provides navigation for getting started guides, covering deployment on Windows Server or Docker environments.

--------------------------------

### Install Pdftools OCR Service - Log File

Source: https://www.pdf-tools.com/docs/ocr-service/getting-started

This snippet shows an example path to a worker log file for verifying the Pdftools OCR Service installation.

```text
C:\\ProgramData\\Pdftools\\OcrService\\logs\\worker-log20251007.txt
```

--------------------------------

### Get Started with Toolbox Add-on using C

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to work with samples and integrate the Toolbox add-on using C. This guide focuses on C integration with the Toolbox add-on.

--------------------------------

### Run Sample Project

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/getting-started

Commands to compile and run a sample PDF Viewer SDK project. This includes installing dependencies, building the project, and starting the development server.

```bash
npm install
```

```bash
npm run build
```

```bash
npm run dev
```

--------------------------------

### Get Started with Toolbox SDK using .NET

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to work with samples and integrate the Toolbox SDK using .NET. This guide focuses on leveraging the Toolbox SDK's capabilities.

--------------------------------

### Get Started with PDF Tools SDK using Go

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to use interface binding to support Go with the Pdftools SDK. This guide covers Go integration for advanced PDF functionalities.

--------------------------------

### Get Started with PDF Tools SDK using C

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to work with samples and integrate the Pdftools SDK using C. This guide covers C-specific integration for PDF functionalities.

--------------------------------

### Get Started with Toolbox SDK

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/toolbox-add-on

Guides on how to get started with the Toolbox add-on and Pdftools SDK for various programming languages. Includes integration steps and sample usage.

```.NET
/* .NET code for integrating Toolbox SDK */
// Example usage:
// ToolboxSDK sdk = new ToolboxSDK();
// sdk.Initialize();
```

```C
/* C code for integrating Toolbox add-on */
// Example usage:
// ToolboxAddon* addon = initializeToolboxAddon();
// processPdf(addon, "input.pdf");
```

```Java
/* Java code for integrating Toolbox add-on */
// Example usage:
// ToolboxAddon addon = new ToolboxAddon();
// addon.load("document.pdf");
```

```Python
/* Python code for using Toolbox add-on */
// Example usage:
// from toolbox import ToolboxAddon
// addon = ToolboxAddon()
// addon.process_file("input.pdf")
```

--------------------------------

### Getting Started with the Toolbox Add-on

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Get up and running with the Toolbox add-on to enhance your PDF processing capabilities.

--------------------------------

### Get Started with Toolbox Add-on using Java

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to work with samples and integrate the Toolbox add-on using Java. This guide covers Java integration with the Toolbox add-on.

--------------------------------

### Install PDF Web Viewer SDK

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/getting-started

Installs the PDF Web Viewer package using npm. This command adds the necessary SDK files to your project's node_modules directory.

```bash
npm install @pdftools/pdf-web-viewer
```

--------------------------------

### Get Started with PDF Tools SDK using .NET

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to work with samples and integrate the Pdftools SDK using .NET. This guide helps you set up your development environment for PDF manipulation.

--------------------------------

### Use Pdftools SDK with Go

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk

Learn how to use interface binding to support Go and other programming languages with the Pdftools SDK. This guide uses Go as an illustrative example.

```go
// Example Go code for Pdftools SDK integration would go here.
// This is a placeholder as no specific Go code was provided in the input.
```

--------------------------------

### Install Pdftools OCR Service - AppSettings

Source: https://www.pdf-tools.com/docs/ocr-service/getting-started

This snippet shows the path to the appsettings.json file where the license key needs to be inserted for the Pdftools OCR Service installation.

```json
C:\\Program Files\\Pdftools\\Pdftools OCR Service\\PdftoolsOcrWorker\\appsettings.json
```

--------------------------------

### Get Started with Toolbox Add-on using Python

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to use interface binding to use Python with the Toolbox add-on. This guide focuses on Python integration with the Toolbox add-on.

--------------------------------

### Getting Started with PDF Tools SDK, Toolbox Add-on, and Shell Tool

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn to get up and running with the Pdftools SDK, the Toolbox add-on, and the Pdftools SDK Shell Tool for comprehensive PDF management.

--------------------------------

### Get Started with PDF Tools SDK using Java

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to work with samples and integrate the Pdftools SDK using Java. This guide provides Java-specific instructions for PDF SDK integration.

--------------------------------

### Install PDF Viewer SDK via npm

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/4/getting-started

Command to install the PDF Viewer SDK package from npm. This command adds the SDK as a dependency to your project, making its components available for use.

```Shell
npm i @pdf-tools/four-heights-pdf-web-viewer --save
```

--------------------------------

### Configure OCR - Example Parameters

Source: https://www.pdf-tools.com/docs/ocr-service/getting-started

This code snippet provides an example of multiple parameters that can be set in the Conversion Service Configurator for the Pdftools OCR Service.

```properties
PredefinedProfile=DocumentArchiving_Accuracy;PreprocessingOnly=false;RemoveGarbage=0;RecognizeBlankPages=false;BlankPageMargin=0.02;DisableMaskEmbedding=false
```

--------------------------------

### Run PDF Viewer SDK Sample (TypeScript)

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/4/getting-started

Steps to run a sample project for the PDF Viewer SDK using TypeScript. This involves navigating to the sample directory, installing dependencies, building the project, and running the development server.

```Shell
npm install
```

```Shell
npm run build
```

```Shell
npm run dev
```

--------------------------------

### Getting Started with the PDF Tools SDK

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Get up and running with the Pdftools SDK to integrate advanced PDF optimization, validation, and manipulation functionalities into your in-house application.

--------------------------------

### Get Started with PDF Tools SDK using Python

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Learn how to use interface binding to use Python with the Pdftools SDK. This guide details Python integration for PDF optimization and validation.

--------------------------------

### Get Started with PDF Viewer SDK

Source: https://www.pdf-tools.com/docs/llms

Instructions for setting up and beginning to use the PDF Viewer SDK in your development environment.

--------------------------------

### Get Started with Pdftools SDK (.NET)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/pdftools-sdk

Learn how to integrate and use the Pdftools SDK within a .NET environment. This guide helps developers get started with samples and implementation for .NET applications.

```.NET
This guide is available in the Pdftools SDK documentation.
```

--------------------------------

### Eclipse IDE Run Configuration Arguments

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-java

Provides example arguments to be used when configuring and running the Pdftools SDK sample project within the Eclipse IDE for Java Application.

```properties
PdfPrimerWhitepaper.pdf OutputPdfPrimerWhitePaper.tiff
```

--------------------------------

### Compile and Run Sample Project (Command Line)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-c

These command-line instructions guide users through compiling and running a sample C project for the PDF Tools Toolbox add-on. It covers CMake configuration, building the project, and executing the image extraction tool.

```shell
cmake .

```

```shell
cmake --build .

```

```shell
./toolboximageextraction ImageCollection.pdf /tmp/images

```

```shell
./toolboximageextraction INPUT_FILE OUTPUT_FILE

```

--------------------------------

### Get Started with PDF Tools SDK in C

Source: https://www.pdf-tools.com/docs/llms

Learn how to integrate the PDF Tools SDK using C. This guide covers working with samples to implement PDF functionalities.

```C
/*
 * This is a placeholder for C code examples.
 * Actual code would involve SDK initialization and function calls.
 */
#include <stdio.h>

int main() {
    printf("Getting started with PDF Tools SDK in C.\n");
    // SDK integration code would go here
    return 0;
}
```

--------------------------------

### Getting Started with Pdftools SDK

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/pdftools-sdk

An introduction to getting started with the Pdftools SDK, enabling integration of advanced PDF optimization, validation, and manipulation into applications.

```General
This guide is available in the Pdftools SDK documentation.
```

--------------------------------

### Integrate Toolbox Add-on with .NET

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox

Learn how to work with samples and integrate the Toolbox SDK using .NET. This guide details the .NET integration process for the Toolbox add-on.

```C#
// C# code examples for .NET integration would go here.
```

--------------------------------

### Integrate Pdftools SDK with .NET

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk

Learn how to work with sample projects and integrate the Pdftools SDK using the .NET framework. This guide is designed for .NET developers.

```csharp
// Example C# code for Pdftools SDK integration would go here.
// This is a placeholder as no specific .NET code was provided in the input.
```

--------------------------------

### Basic PDF Viewer HTML Setup

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/4/getting-started

Provides the basic HTML structure for embedding the PDF Viewer SDK. It includes setting the `PDFTOOLS_FOURHEIGHTS_PDFVIEWING_BASEURL` and linking the viewer's CSS.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <script type="text/javascript">
      // path to static assets must be set before the viewer is loaded
      window.PDFTOOLS_FOURHEIGHTS_PDFVIEWING_BASEURL = './pdfwebviewer/'
    </script>
    <link rel="stylesheet" type="text/css" href="./pdfwebviewer/pdf-web-viewer.css" />
    <title>PDF Web Viewer</title>
  </head>
  <body>
    {/* HTM element containing the PdfWebViewer. */}
    <div id="pdfviewer" style="height: 100vh; width: 100vw"></div>
  </body>
</html>
```

--------------------------------

### Convert PDF using pdfclient

Source: https://www.pdf-tools.com/docs/conversion-service/4/getting-started

This command-line example demonstrates how to convert a PDF file using the 'pdfclient' tool. It takes an input PDF file and generates an output PDF file in the current directory.

```Shell
pdfclient -v input.pdf output.pdf
```

--------------------------------

### Integrate Pdftools SDK with C

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk

Learn how to work with sample projects and integrate the Pdftools SDK using the C programming language. This guide covers the necessary steps for C developers.

```c
// Example C code for Pdftools SDK integration would go here.
// This is a placeholder as no specific C code was provided in the input.
```

--------------------------------

### Initialize PDF Viewer with JavaScript

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/4/getting-started

Demonstrates how to initialize the PDF Viewer SDK using JavaScript. It involves getting the target element, setting a license key (optional), and creating a new `PdfWebViewer` instance.

```javascript
import { PdfWebViewer } from '@pdf-tools/four-heights-pdf-web-viewer'

const element = document.getElementById('pdfviewer')
const license = ''

// use default options
const options = {}

const pdfViewer = new PdfWebViewer(element, license, options)
```

--------------------------------

### Get Started with Pdftools SDK (C)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/pdftools-sdk

This guide provides instructions for integrating and utilizing the Pdftools SDK with C programming. It covers working with samples and implementing SDK functionalities in C applications.

```C
This guide is available in the Pdftools SDK documentation.
```

--------------------------------

### Integrate Toolbox Add-on with C

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox

Learn how to work with samples and integrate the Toolbox add-on using C. This guide focuses on C-specific implementation details for PDF file manipulation.

```C
// C code examples for Toolbox add-on integration would go here.
```

--------------------------------

### Add PDF Tools SDK (Maven - macOS ARM64)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-java

This snippet provides the Maven dependency setup for the PDF Tools SDK for Java on macOS with ARM64 architecture. It includes the main SDK and the dynamic library (.dylib) for this platform.

```xml
<dependency>
    <groupId>com.pdftools</groupId>
    <artifactId>pdftools-sdk</artifactId>
    <version>1.13.0</version>
</dependency>
<dependency>
    <groupId>com.pdftools</groupId>
    <artifactId>pdftools-sdk</artifactId>
    <version>1.13.0</version>
    <classifier>osx-arm64</classifier>
    <type>dylib</type>
</dependency>
```

--------------------------------

### Binding C API with Go for PDF Tools SDK

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-other-languages

This snippet demonstrates how to bind the C API of the PDF Tools SDK with Go. It requires Go 1.6 or higher to be installed and accessible in the system's PATH.

```Go
// Example Go code for binding the C API would go here.
// This would involve using cgo to call C functions.
// For instance:
// #cgo CFLAGS: -I/path/to/pdftools/include
// #cgo LDFLAGS: -L/path/to/pdftools/lib -lpdftools
// #include <pdftools.h>
import "C"

func main() {
    // Call C API functions using C.FunctionName()
    // Example: C.Pdftools_Initialize()
}

```

--------------------------------

### View PDF File with PDF Viewer SDK

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/tags/custom-implementation

A fundamental guide on how to display and view a PDF file using the PDF Viewer SDK. Covers the basic setup and rendering process.

```javascript
// Example for loading and viewing a PDF
// viewer.open('path/to/your/document.pdf');
```

--------------------------------

### Update Toolbox Add-on Python Installation Command

Source: https://www.pdf-tools.com/docs/whats-new/july-2025

This snippet shows the updated, shorter `pip install` commands for the Toolbox add-on Python getting started guide. It is relevant for users working with the Toolbox add-on in Python.

```Python
pip install pdftools-toolbox
```

--------------------------------

### Update Pdftools SDK Python Installation Command

Source: https://www.pdf-tools.com/docs/whats-new/july-2025

This snippet shows the updated, shorter `pip install` commands for the Pdftools SDK Python getting started guide. It is relevant for users working with the Pdftools SDK in Python.

```Python
pip install pdftools-sdk
```

--------------------------------

### Compile and Run C Sample Project

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-c

This snippet demonstrates how to compile and run a C sample project for the PDF Tools SDK. It includes commands for CMake to build the project and execute the PDF to image conversion.

```bash
cmake .
cmake --build .
./pdftoolspdf2imgsimple PdfPrimerWhitePaper.pdf PdfPrimerWhitePaper.tiff
```

--------------------------------

### Installation and Configuration Differences for Conversion Service

Source: https://www.pdf-tools.com/docs/llms

This page explains the differences in installation and configuration when setting up the Conversion Service compared to previous versions or other converters.

```Installation/Configuration
This page explains differences in the installation and configuration for the Conversion Service.
```

--------------------------------

### Start Job using HttpClient in C#

Source: https://www.pdf-tools.com/docs/conversion-service/5/api/advanced-api/start-job

Example of how to start a job using HttpClient in C#. This code sends a GET request to the base URL and handles the response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:13033/conversion/v1.0/rest");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Using the PDF Tools SDK Shell Tool

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/getting-started

Use the Pdftools SDK from the command line for efficient PDF manipulation and automation.

--------------------------------

### Configure OCR - Example Languages

Source: https://www.pdf-tools.com/docs/ocr-service/getting-started

This code snippet provides an example of setting multiple natural and technical languages for OCR recognition in the Conversion Service Configurator.

```text
English,German,French,Tagalog,Corsican,Spanish,Chemistry,Java
```

--------------------------------

### Execute PDF Tools Java Sample with Placeholders

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-java

A general command to run the PDF Tools Java sample project, specifying input file and output directory. This serves as a template for custom extraction tasks.

```Java
java -cp jar/com.pdftools.toolbox.jar:bin:. ToolboxImageExtraction INPUT_FILE OUTPUT_DIRECTORY  

```

```Java
java -cp jar/com.pdftools.toolbox.jar;bin;. ToolboxImageExtraction INPUT_FILE OUTPUT_DIRECTORY  

```

--------------------------------

### Install PDF Tools SDK using pip

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-python

Installs the PDF Tools SDK package using pip. This is a prerequisite for using the SDK in your Python project.

```bash
pip install pdftools_sdk
```

--------------------------------

### Install PDF Tools Toolbox Package (Bash)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-python

Installs the pdftools_toolbox Python package using pip. This command needs to be executed in the terminal to make the library available for your project.

```Bash
pip install pdftools_toolbox  
```

--------------------------------

### Run Java PDF to Image Conversion with Placeholders (Windows)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-java

Demonstrates how to run the Java sample project for PDF to image conversion on Windows, using placeholder arguments for input and output files. This allows for flexible file path specification.

```batch
java -cp jar/com.pdftools.jar;bin;. PdfToolsPdf2ImgSimple INPUT_FILE OUTPUT_FILE
```

--------------------------------

### Get Started with PDF Tools SDK in Python

Source: https://www.pdf-tools.com/docs/llms

Learn how to integrate the PDF Tools SDK using Python. This guide covers working with samples to implement PDF functionalities.

```Python
# This is a placeholder for Python code examples.
# Actual code would involve SDK initialization and function calls.

print("Getting started with PDF Tools SDK in Python.")
# SDK integration code would go here

```

--------------------------------

### Get Started with PDF Tools SDK in Java

Source: https://www.pdf-tools.com/docs/llms

Learn how to integrate the PDF Tools SDK using Java. This guide covers working with samples to implement PDF functionalities.

```Java
/*
 * This is a placeholder for Java code examples.
 * Actual code would involve SDK initialization and function calls.
 */
public class PdfToolsExample {
    public static void main(String[] args) {
        System.out.println("Getting started with PDF Tools SDK in Java.");
        // SDK integration code would go here
    }
}
```

--------------------------------

### Get Started with PDF Tools SDK in .NET

Source: https://www.pdf-tools.com/docs/llms

Learn how to integrate the PDF Tools SDK using .NET. This guide covers working with samples to implement PDF functionalities.

```C#
/*
 * This is a placeholder for .NET code examples.
 * Actual code would involve SDK initialization and function calls.
 */
using System;

public class PdfToolsExample
{
    public static void Main(string[] args)
    {
        Console.WriteLine("Getting started with PDF Tools SDK in .NET.");
        // SDK integration code would go here
    }
}
```

--------------------------------

### Run Java PDF to Image Conversion with Placeholders (macOS/Linux)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-java

Demonstrates how to run the Java sample project for PDF to image conversion on macOS and Linux, using placeholder arguments for input and output files. This allows for flexible file path specification.

```bash
java -cp jar/com.pdftools.jar:bin:. PdfToolsPdf2ImgSimple INPUT_FILE OUTPUT_FILE
```

--------------------------------

### Initialize Toolbox Add-on with License Key (.NET)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-dotnet

Initializes the Toolbox add-on with a provided license key. This is a crucial step before using any of its functionalities. Ensure the license key is correctly formatted, including '<' and '>' signs.

```C#
Sdk.Initialize("insert-license-key-here", null);

```

--------------------------------

### Build and Run PDF to Image Converter

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-other-languages

Instructions on how to compile and execute the Go program for PDF to image conversion. This involves building the executable using `go build` and then running it with the input PDF file path and the desired output image file path as command-line arguments.

```shell
go build

```

```shell
pdf2img <path to input PDF file> <path to output image file>

```

--------------------------------

### Use Pdftools SDK with Python

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk

Learn how to use interface binding to work with the Pdftools SDK using Python. This guide focuses on Python integration methods.

```python
# Example Python code for Pdftools SDK integration would go here.
# This is a placeholder as no specific Python code was provided in the input.
```

--------------------------------

### Activate Conversion Service License Key in Docker

Source: https://www.pdf-tools.com/docs/licenses/products/conversion-service-license

For users running the Conversion Service in Docker, this guide explains how to set the Licensing Gateway Service address using the `LICENSINGSERVICE` environment variable. Refer to the Docker getting started guide for detailed steps.

```bash
LICENSINGSERVICE=<lgs_address>
```

--------------------------------

### Run Sample Project for Image Extraction (CLI)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-dotnet

Compiles and runs a .NET sample project to extract all images and image masks from a PDF document using the command line interface. It takes the input PDF file and an output directory as arguments.

```bash
dotnet run --framework net6.0 --project ToolboxImageExtraction.csproj ImageCollection.pdf /tmp/images

```

```bash
dotnet run --framework net6.0 --project ToolboxImageExtraction.csproj INPUT_FILE OUTPUT_DIRECTORY

```

--------------------------------

### Run Sample Project for Image Extraction (Visual Studio)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-dotnet

Executes a .NET sample project compiled in Visual Studio to extract images and image masks from a PDF. The compiled application takes the input PDF file and an output directory as parameters.

```bash
ToolboxImageExtraction ImageCollection.pdf /tmp/images

```

```bash
ToolboxImageExtraction INPUT_FILE OUTPUT_DIRECTORY

```

--------------------------------

### Get Started with Python and PDF Tools

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/pdf-library-in-python

Guides on using interface binding to work with Python and the Pdftools SDK or the Toolbox add-on. Learn to integrate advanced PDF functionalities.

```Python
# Python interface binding for Pdftools SDK
# Example: Integrating PDF manipulation
```

```Python
# Python interface binding for Toolbox add-on
# Example: Accessing PDF content
```

--------------------------------

### Integrate Pdftools SDK with Java

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk

Learn how to work with sample projects and integrate the Pdftools SDK using the Java programming language. This guide is intended for Java developers.

```java
// Example Java code for Pdftools SDK integration would go here.
// This is a placeholder as no specific Java code was provided in the input.
```

--------------------------------

### Get Started with Pdftools SDK (Java)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/pdftools-sdk

Learn how to integrate and use the Pdftools SDK in Java applications. This guide covers working with samples and implementing the SDK's features for Java developers.

```Java
This guide is available in the Pdftools SDK documentation.
```

--------------------------------

### Initialize PDF Tools SDK with License Key (C)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-c

This C code snippet demonstrates how to initialize the PDF Tools SDK by setting the license key. It includes error handling for the initialization process.

```c
GOTO_CLEANUP_IF_FALSE_PRINT_ERROR(Ptx_Sdk_Initialize(_T("insert-license-key-here"), NULL),  
                                  _T("Failed to set license key. %s (ErrorCode: 0x%08x).\n"), szErrorBuff,  
                                  Ptx_GetLastError());  

```

--------------------------------

### Configure Apache MIME Types

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/4/getting-started

Provides the `.htaccess` configuration for an Apache web server to set the correct MIME types for `.mem`, `.data`, and `.wasm` files, enabling proper loading of PDF Viewer SDK assets.

```bash
AddType application/octet-stream ".mem"
AddType application/octet-stream ".data"
AddType application/wasm         ".wasm"
```

--------------------------------

### Get Started with Pdftools SDK (Python)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/tags/pdftools-sdk

Learn how to use interface binding to integrate the Pdftools SDK with Python. This guide helps Python developers leverage the SDK's capabilities for PDF manipulation.

```Python
This guide is available in the Pdftools SDK documentation.
```

--------------------------------

### Run Java Sample Project for Image Extraction

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox/toolbox-java

Executes the compiled Java sample project to extract images and image masks from a PDF file into a specified output directory. The command includes the Toolbox JAR, bin directory, and current directory in the classpath.

```Java
java -cp jar/com.pdftools.toolbox.jar:bin:. ToolboxImageExtraction ImageCollection.pdf /output_images  

```

```Java
java -cp jar/com.pdftools.toolbox.jar;bin;. ToolboxImageExtraction ImageCollection.pdf /output_images  

```

--------------------------------

### Use Python with Toolbox Add-on

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox

Learn how to use interface binding to use Python with the Toolbox add-on. This guide explains Python's role in interacting with the PDF tools.

```Python
# Python code examples for Toolbox add-on usage would go here.
```

--------------------------------

### Integrate Toolbox Add-on with Java

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/toolbox

Learn how to work with samples and integrate the Toolbox add-on using Java. This guide covers Java-based approaches for accessing and manipulating PDF content.

```Java
// Java code examples for Toolbox add-on integration would go here.
```

--------------------------------

### Compile Java Sample Project (Windows)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-java

Compiles the Java source file for the Pdftools SDK sample project using the command line on Windows. It requires the SDK JAR file and specifies the output directory.

```batch
javac -cp jar/com.pdftools.jar;. PdfToolsPdf2ImgSimple.java
```

--------------------------------

### General Pdftools SDK Shell Tool Usage

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk-shell-tool

Demonstrates the basic command structure for the Pdftools SDK Shell Tool, showing how to specify SDK options, input files with their options, commands, and output files with their options.

```Shell
> pdf [sdk_options] <input> [input_options] <command> [: <command>] [<output> [output_options]]  
```

--------------------------------

### Compile Java Sample Project (macOS/Linux)

Source: https://www.pdf-tools.com/docs/pdf-tools-sdk/getting-started/pdftools-sdk/pdftools-sdk-java

Compiles the Java source file for the Pdftools SDK sample project using the command line on macOS and Linux. It requires the SDK JAR file and specifies the output directory.

```bash
javac -cp jar/com.pdftools.jar:. PdfToolsPdf2ImgSimple.java
```

--------------------------------

### Install Conversion Service Client with Service URL

Source: https://www.pdf-tools.com/docs/conversion-service/4/integrate

This command installs the Conversion Service client using msiexec and preconfigures the service URL. This is useful for automated installations where the service URL needs to be set beforehand.

```bash
msiexec /i ConversionService.msi SERVICE_URL=http://localhost:13033/conversion/v1.0/rest
```

--------------------------------

### Install Conversion Service Client with Service URL

Source: https://www.pdf-tools.com/docs/conversion-service/5/integrate

This command installs the Conversion Service client and preconfigures the service URL for automated installations. It uses msiexec with the /i flag for installation and sets the SERVICE_URL property.

```Shell
msiexec /i ConversionService.msi SERVICE_URL=http://localhost:13033/conversion/v1.0/rest   
```

--------------------------------

### Get Job Result Data (Problem JSON Example)

Source: https://www.pdf-tools.com/docs/conversion-service/5/api/advanced-api/get-job-result-data

Provides an example of a problem detail response in JSON format, indicating that a job was not found.

```json
{
  "type": "http://www.pdf-tools.com/service/rest/errors/jobNotFound",
  "title": "Job not found.",
  "detail": "The job with ID 'job_XYZ' could not be found",
  "status": 404
}
```

--------------------------------

### Get Job Info Error Response Example (JSON)

Source: https://www.pdf-tools.com/docs/conversion-service/4/api/get-job-info

A specific example of a JSON response when the requested job ID is not found, providing detailed error information.

```json
{
    "type": "http://www.pdf-tools.com/service/rest/errors/jobNotFound",
    "title": "Job not found.",
    "detail": "The job with ID 'job_XYZ' could not be found",
    "status": 404
}
```

--------------------------------

### Full PDF Viewer Example (HTML and TypeScript)

Source: https://www.pdf-tools.com/docs/pdf-web-viewer/guides/document-view

A complete example demonstrating how to set up and display a PDF document using the PDF Web SDK. It includes the necessary HTML structure and TypeScript code for initialization, view creation, and document loading.

```html
<!doctype html>  
<html lang="en">  
  <head>  
    <meta charset="UTF-8" />  
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />  
    <title>PDF Viewer SDK</title>  
  </head>  
  <body>  
    <div  
      id="pdftools-web-viewer-container"  
      style="width:100vw; height: 100vh;"  
    ></div>  
  </body>  
</html>  

```

```typescript
import { pdfToolsWebSdk, Pdf, UI } from '@pdftools/pdf-web-sdk';  
  
async function initialize() {  
  await pdfToolsWebSdk.initialize({  
    path: './pdftools-web-sdk/',  
  });  
  
  const container = document.querySelector('#pdftools-web-viewer-container');  
  const documentView = new UI.DocumentView(container);  
  
  const controller = new Pdf.Controller();  
  const pdfDocument = await controller.openDocument({  
    uri: '/pdf/WebViewer_Demo.pdf',  
  });  
  
  documentView.initialize(pdfDocument);  
}  
  
initialize();  

```
Tokens:
Raw