Go PDF library integration

Welcome to Apryse. Go for the Apryse SDK is cross-platform and supported on Windows, Linux and macOS. To get started, choose your preferred platform from the tabs below.

Windows

Windows Go library integration

This guide will help you run Apryse samples and integrate the Apryse SDK into Go applications on Windows. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

• Go (>= 1.15)
• Git

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Running Apryse Go in your project

1. Create a directory for your project and a main.go file within. Add the following code to your main.go:

package main

import (
    . "github.com/pdftron/pdftron-go/v2"
)


func main() {
    PDFNetInitialize("YOUR_APRYSE_LICENSE_KEY");
    doc := NewPDFDoc()
    page := doc.PageCreate()     // Start a new page
    doc.PagePushBack(page)       // Add the page to document
    doc.Save("output.pdf", uint(SDFDocE_linearized)); // Save the document as a linearized PDF
    doc.Close()
}

1. Initialize your go.mod:

go mod init

1. Fetch the dependencies for your project:

go get

1. Set your PATH to point to the shared libraries in pdftron-go in your current command shell. Replace your_version with the version of pdftron-go you are running:

set PATH=%PATH%;%GOPATH%/pkg/mod/github.com/pdftron/pdftron-go/v2@your_version/shared_libs/win/Lib

Or in powershell:

$env:PATH += ';$env:GOPATH/pkg/mod/github.com/pdftron/pdftron-go/v2@your_version/shared_libs/win/Lib'

You may also copy the .dll files from the above path to the same place as your project executable.

1. Set the CGO_ENABLED environment variable to 1:

set CGO_ENABLED=1

Or in powershell:

$env:CGO_ENABLED="1"

1. Install a C compiler, like MinGW, TDM-GCC, LLVM/Clang, or MSVC, and add its location to your PATH.
2. Set the CC environment variable to the C compiler you installed. For MinGW/TDM-GCC, its "gcc". For LLVM/Clang, its "clang". For MSVC, its "cl.exe".

set CC="gcc"

Or in powershell:

$env:CC="gcc"

1. Run your created application:

go run main.go

Running Apryse Go samples

1. Navigate to your go path where you installed the library, and search for our repository. It may be within this path based on your version of Golang.

$GOPATH/pkg/mod/github.com/pdftron/pdtron-go/v2@version

1. Navigate to the ./samples directory and modify the runall_go.bat and set your LICENSE_KEY. If using Apryse modules such as CAD, MODULE_PATH to the directory where your modules are stored.
2. Run the runallgo.bat. All sample tests will be run. a. If you wish to run a specific test, this can be done by specifying the test ./runall_go.bat AddImageTest

PDFNet is running in demo mode.
Permission: write
Done!

Output files will be created in ./TestFiles/Output

Running a specific version of Apryse Go

This can be done by modifying your go.mod via this command in your project directory.

go mod edit -require github.com/pdftron/pdftron-go/v2@v2.0.0`
go get

Next steps

GuidesSamples

Linux

Linux Go library integration

This guide will help you run Apryse samples and integrate the Apryse SDK into Go applications on Linux. Your free trial includes unlimited trial usage and support from solution engineers.

Download the SDK

Prerequisites

• Go (>= 1.15)
• Git

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Running PDFTron Go in your project

1. Create a directory for your project and a main.go file within. Add the following code to your main.go.

package main

import (
    . "github.com/pdftron/pdftron-go/v2"
)


func main() {
    PDFNetInitialize("YOUR_APRYSE_LICENSE_KEY");
    doc := NewPDFDoc()
    page := doc.PageCreate()     // Start a new page
    doc.PagePushBack(page)       // Add the page to document
    doc.Save("output.pdf", uint(SDFDocE_linearized)); // Save the document as a linearized PDF
    doc.Close()
}

1. Initialize your go.mod

go mod init

1. Fetch the dependencies for your project.

go get

1. Run your created application.

go run main.go

Running PDFTron Go samples

1. Navigate to your go path where you installed the library, and search for our repository. It may be within this path based on your version of Golang.

$GOPATH/pkg/mod/github.com/pdftron/pdtron-go/v2@version

1. Navigate to the ./samples directory and modify the runall_go.sh and set your LICENSE_KEY. If using Apryse modules such as CAD, MODULE_PATH to the directory where your modules are stored.
2. Run the runall_go.sh. All sample tests will be run. a. If you wish to run a specific test, this can be done by specifying the test ./runall_go.sh AddImageTest

Output files will be created in ./TestFiles/Output

Running a specific version of PDFTron Go

This can be done by modifying your go.mod via this command in your project directory.

go mod edit -require github.com/pdftron/pdftron-go/v2@v2.0.0`
go get

Next steps

GuidesSamples

macOS

macOS Go library integration

This guide will help you run Apryse samples and integrate the Apryse SDK into Go applications on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

Download the SDK

Prerequisites

• Go (>= 1.15)
• Git

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Running PDFTron Go in your project

1. Create a directory for your project and a main.go file within. Add the following code to your main.go.

package main

import (
    . "github.com/pdftron/pdftron-go/v2"
)

func main() {
    PDFNetInitialize("YOUR_APRYSE_LICENSE_KEY");
    doc := NewPDFDoc()
    page := doc.PageCreate()     // Start a new page
    doc.PagePushBack(page)       // Add the page to document
    doc.Save("output.pdf", uint(SDFDocE_linearized)); // Save the document as a linearized PDF
    doc.Close()
}

1. Initialize your go.mod

go mod init

1. Fetch the dependencies for your project.

go get

1. Run your created application.

go run main.go

Running PDFTron Go samples

1. Navigate to your go path where you installed the library, and search for our repository. It may be within this path based on your version of Golang.

$GOPATH/pkg/mod/github.com/pdftron/pdtron-go/v2@version

1. Navigate to the ./samples directory and modify the runall_go.sh and set your LICENSE_KEY. If using Apryse modules such as CAD, MODULE_PATH to the directory where your modules are stored.
2. Run the runall_go.sh. All sample tests will be run. a. If you wish to run a specific test, this can be done by specifying the test ./runall_go.sh AddImageTest

Output files will be created in ./TestFiles/Output

Running a specific version of PDFTron Go

This can be done by modifying your go.mod via this command in your project directory.

go mod edit -require github.com/pdftron/pdftron-go/v2@v2.0.0`
go get

Next steps

GuidesSamples