Product:

Get started

Overview

Platforms

Frameworks

.NET

.NET Framework (C#, VB)

Node.js

Languages

Download

Get a trial key

Release notes

Viewer

Basic operations

Learn more

Annotation

MS Office

Generate via template

Conversion

Smart Data Extraction

Augmenting LLMs with Smart Data Extraction

PDF/A

Accessibility

Forms

Create

Page manipulation

PDF Editing

OCR

Digital signature

Comparison

Bookmark

Optimization

Layer (OCG)

Redaction

Sanitization

Security

Portfolio

Low-level PDF API

Handwriting ICR

Changelogs

Get started with the Apryse Server SDK .NET PDF library integration

The Apryse Server SDK is cross-platform and supported on Windows, Linux, and macOS. The base package is robust, allowing you to programmatically do the following with PDFs:

Additional functionality

If you’re looking for additional capabilities, we offer add-on packages, such as Smart Data Extraction, and add-on modules, such as Office Conversion. For a complete list of add-ons, refer to the following:

Solutions and benefits

Using the Server SDK allows you to build server-side document-processing solutions at scale without relying on client devices or cloud APIs. Since the Server runs entirely on-premises (or in your private cloud), you can ensure security and compliance with full control over access, storage, and encryption. You can also easily integrate with web apps, backend systems, document management systems, and content workflows.

Steps and samples

This get-started guide explains how to install and use the Apryse Server SDK in a .NET application. It includes the full .NET PDF library and sample modules. We'll focus on the OfficeToPDFTest sample to convert Office documents to PDF and demonstrate how to build a simple app for programmatic PDF generation.

Get started video

Get started with the Apryse Server SDK and .NET on Windows by watching this 4-minute video. You can skip the video and follow the step-by-step instructions instead.

Get started video for Apryse Server SDK on the Windows platform

To get started, choose your preferred platform from the following tabs.

Windows .NET PDF library integration

In this guide, you'll explore sample PDFNet projects to understand the types of PDF outputs you can create with the Apryse Server SDK. You'll also create a simple .NET application, add the Apryse Server SDK, and learn how to generate files programmatically.

Prerequisites

Before you start:

Install Visual Studio to build, test, and deploy applications.
Install the latest active version of the .NET SDK to build your application.
Download the Apryse .NET PDF library for Windows.
Get your Apryse trial key.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run Apryse SDK in production.

A commercial license key is required for use in a production environment. Contact sales to purchase a commercial license key.

Keep your commercial license key confidential.

License keys are uniquely generated and strictly confidential. Don't publish or store them in any public location, including public GitHub repositories.

1. Convert DOCX to PDF

In this section, you’ll use the OfficeToPDFTest sample to convert a DOCX file to PDF using the Microsoft Office conversion API. You can use this sample to understand how document conversion works and as a reference for your own implementations.

Download the PDFNetC64.zip file.
Unzip the PDFNetC64.zip file to this location. Use a different location if preferred:

Text

1C:\Users\<your_name>\PDFNetC64\Samples\

3. To add your license key, open this file in Visual Studio Code:

Text

1C:\Users\<your_name>\PDFNetC64\Samples\LicenseKey\CS\LicenseKey.cs

4. Go to the private static string key = “YOUR_PDFTRON_LICENSE_KEY”; line and replace the quoted text with your trial license key. Don't change any other information in this file. Save your changes.

C#

LicenseKey.cs

1public static class PDFTronLicense
2{
3    // Add your trial license key here
4    private static string key = "YOUR_PDFTRON_LICENSE_KEY";
5    public static string Key
6    {
7        get
8        {
9            if (key == "YOUR_PDFTRON_LICENSE_KEY" || key == "")
10                throw (new System.Exception("Please enter your license key by replacing \"YOUR_PDFTRON_LICENSE_KEY\" that is assigned to the static string key variable in Samples/LicenseKey/CS/LicenseKey.cs. If you do not have a license key, please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key."));
11            return key;
12        }
13    }
14}

5. Open PowerShell as an administrator, replace <your_name> , and navigate to this directory:

PowerShell

1cd C:\Users\<your_name>\PDFNetC64\Samples\OfficeToPDFTest\CS

6. From the OfficeToPDFTest\CS directory, run this script:

PowerShell

1.\RunTest.bat

When you run the .\RunTest.bat command, the sample code loads a Microsoft Office document, converts it to PDF, saves the PDF, and writes the following status messages to the console. For more details, review the OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

PowerShell

1PDFNet is running in demo mode.
2PackageV2: base
3PackageV2: office_conversion
4Saved Fishermen.pdf
5Saved the_rime_of_the_ancient_mariner.pdf
6Saved factsheet_Arabic.pdf
7Done.

7. Go to this directory to verify that the output PDF files are present:

Text

1C:\Users\<your_name>\PDFNetC64\Samples\TestFiles\Output

The folder structure looks similar to:

Text

1Samples/TestFiles/Output/
2├── factsheet_Arabic.pdf
3├── Fishermen.pdf
4├── the_rime_of_the_ancient_mariner.pdf

8. Open the PDF files to see the converted output. The original DOCX files are located in the PDFNetC64\Samples\TestFiles folder.

Converted PDF file showing the output generated from a DOCX document

2. Create a .NET PDF app

Create a simple .NET application that uses the Apryse Server SDK and PDFNet library to generate a PDF programmatically. In this section, you’ll set up a minimal project, add the required code, and run a script that creates a blank PDF document. This example provides a practical foundation for building more advanced document‑generation workflows.

Set up your project

Set up your project by creating a folder and preparing your workspace for the application.

Open Visual Studio and go to File > New > Project.
When creating a new project, select Console App, then click Next.
Add a Project name.
Specify where to save your project using the Location field, then click Next.

Info

Remember the file location for your project. You'll need it later when verifying this workflow.

5. In the Framework dropdown, select the .NET version. For example, .NET 8 (Long Term Support), then click Create. A default app is created, where you can run and debug your project.

Add the SDK to your app

Next, integrate the Apryse Server SDK into your .NET application and add the code needed to generate a PDF.

In Visual Studio, go to Tools > NuGet Package Manager > Manage NuGet Packages for Solution.
From the Browse tab, enter Apryse in the Search field. This shows you the various packages that Apryse has published.
From the search results, select PDFTron.NET.x64.
In the Manage Packages for Solution dialog, select the project, then click Install.

Visual Studio Manage NuGet Packages window showing the PDFTron.NET.x64 package with version options and an Install button.

Manage NuGet Packages dialog in Visual Studio with PDFTron.NET.x64 installation options.

5. In the Preview Changes modal, click Apply to install the package in your project.

6. Check the Output window (Package Manager) to confirm the installation completed successfully:

Text

1Restoring packages...
2Installed PDFTron.NET.x64 11.12.1 from...
3Installing NuGet package PDFTron.NET.x64 11.12.1...
4Generating MSBuild file...
5Writing assets file to disk...
6Successfully installed 'PDFTron.NET.x64'
7========== Finished ==========

7. Go to the Program.cs file in the Solutions Explorer. Replace the entire file with this code, making sure to update your license key and save the file:

C#

Program.cs

1// Import namespaces
2using System;
3using pdftron;
4using pdftron.Common;
5using pdftron.PDF;
6using pdftron.SDF;
7
8// Create console app entry point
9namespace myApp
10{
11    class Program
12    {
13        static void Main(string[] args)
14        {
15            Console.WriteLine("Hello World!");
16            
17            // Initialize Apryse SDK
18            // Replace with your demo license key
19            PDFNet.Initialize("YOUR_LICENSE_KEY");
20            
21            // Using PDFNet related classes and methods, must
22            // catch or throw PDFNetException
23            try
24            {
25                using (PDFDoc doc = new PDFDoc())
26                {
27                    doc.InitSecurityHandler();
28                    // Start a new page
29                    Page newPg = doc.PageCreate();
30                    
31                    // Add page to document
32                    doc.PagePushBack(newPg);
33                    
34                    // Save document as a linearized PDF
35                    doc.Save("output.pdf", SDFDoc.SaveOptions.e_linearized);
36                    System.Console.WriteLine("Done. Results saved in linearized_output.pdf");
37                }
38            }
39            catch (PDFNetException e)
40            {
41                System.Console.WriteLine(e.Message);
42            }
43            // Make the program wait to terminate after user input
44            Console.ReadKey();
45        }
46    }
47}

Info

If you're signed in with an Apryse account, your license key is automatically prepopulated in all code snippets.

With this code, you can:

Initialize the system by logging a startup message.
Import the .NET SDK.
Define an asynchronous Main function to generate the PDF, while the PDFNet engine handles license initialization and cleanup.
Log errors and, once processing is complete, release PDFNet resources and shut down the engine.

Run and verify your setup

Finally, build and run your application to confirm that the Apryse Server SDK is working correctly. After the application runs successfully, it will generate a blank PDF file locally.

In Visual Studio, run the app by selecting the Start button on the toolbar, or by pressing F5. A successful output looks similar to:

Command Prompt

1Hello World!
2
3PDFNet is running in demo mode.
4PackageV2: base
5Done. Results saved in linearized_output.pdf

2. Navigate to this directory, where the build output is created by default:

Text

1C:\Users\<your_name>\source\repos\<project_name>\bin\Debug\<target_framework\

3. Verify the blank output.pdf file was generated programmatically using the Apryse Server SDK. The folder structure looks similar to:

Text

1C:\Users\<your_name>\source\repos\
2└── apryse-console-app\
3    ├── apryse-console-app.sln
4    └── apryse-console-app\
5        └── bin\
6            └── Debug\
7                └── net8.0\
8                    ├── apryse-console-app.deps.json
9                    ├── apryse-console-app.dll
10                    ├── apryse-console-app.exe
11                    ├── apryse-console-app.pdb
12                    ├── apryse-console-app.runtimeconfig.json
13                    ├── libPDFNetC.dylib
14                    ├── libPDFNetC.so
15                    ├── PDFNetC.dll
16                    ├── PDFTronDotNet.dll
17                    └── output.pdf

Now that you've successfully run the OfficeToPDFTest sample (in section 1) and integrated the Apryse Server SDK .NET PDF library into your application, you can try out 50+ samples depending on your needs.

File explorer window on a Windows system showing the Apryse Samples library installed

You can try over fifty samples for the Apryse Server SDK.

To try additional samples, go to section 1. Convert DOCX to PDF > step 6 and choose another sample to run.

This guide will help you set up Apryse SDK serverless Azure functions. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

Initial setup

In this particular guide, we will demonstrate how to set up an Azure function to use Apryse SDK.

First, create an Azure function using this guide.

Next, edit your csproj to include PDFNetC.dll and reference PDFTronDotNet.dll from the download package.

Integrate into your application

Once you have followed the initial setup instructions, you can begin calling Apryse SDK APIs in your Azure function source. For example:

C#

1using System.IO;
2using System.Threading.Tasks;
3using Microsoft.AspNetCore.Http;
4using Microsoft.AspNetCore.Mvc;
5using Microsoft.Azure.WebJobs;
6using Microsoft.Azure.WebJobs.Extensions.Http;
7using Microsoft.Extensions.Logging;
8using Newtonsoft.Json;
9using System;
10using System.Drawing;
11using System.Drawing.Imaging;
12using System.Runtime.InteropServices;
13using pdftron;
14using pdftron.Common;
15using pdftron.PDF;
16using pdftron.SDF;
17namespace FunctionApp
18{
19    public static class YourAzureFunctionClass
20    {
21        [FunctionName("YourAzureFunctionName")]
22        public static async Task<IActionResult> Run(
23            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, ILogger log)
24        {
25            PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY");
26            // your Azure function
27        }
28    }
29}

Run Sample Code

You can update C# script of your Azure function project with the following code or download the source code from our github repository. This snippet shows how to process a request sent from a client to convert an office document to PDF and send the output to client.

C#

1using System.IO;
2using System.Threading.Tasks;
3using Microsoft.AspNetCore.Http;
4using Microsoft.AspNetCore.Mvc;
5using Microsoft.Azure.WebJobs;
6using Microsoft.Azure.WebJobs.Extensions.Http;
7using Microsoft.Extensions.Logging;
8using Newtonsoft.Json;
9using System;
10using System.Drawing;
11using System.Drawing.Imaging;
12using System.Runtime.InteropServices;
13using pdftron;
14using pdftron.Common;
15using pdftron.PDF;
16using pdftron.SDF;
17// This example shows how to create Azure functions using Apryse SDK.
18// A REST API request was posted with base64 encoded data by the client.
19// The request would be processed by the server and a response with base64 encoded data of OfficeToPDF output would be sent to the client.
20namespace FunctionApp
21{
22    public static class OfficeToPDF
23    {
24        [FunctionName("OfficeToPDF")]
25        public static async Task<IActionResult> Run(
26            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
27            ILogger log)
28        {
29            try
30            {
31                log.LogInformation("C# HTTP trigger function processed a request.");
32                string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
33                dynamic data = JsonConvert.DeserializeObject(requestBody);
34                PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY");
35                string file_data = "";
36                string json_data = "";
37                log.LogInformation("Reading file data from the request ...");
38                try
39                {
40                    file_data = System.Convert.ToString(data.file.data);
41                    if (!string.IsNullOrEmpty(file_data))
42                    {
43                        log.LogInformation($"data: {data}");
44                        log.LogInformation("Converting base64 string to bytes...");
45                        Byte[] input_bytes = System.Convert.FromBase64String(file_data);
46                        Byte[] output_bytes;
47                        log.LogInformation("Processing using OfficeToPDF() ...");
48                        pdftron.Filters.MemoryFilter memoryFilter = new pdftron.Filters.MemoryFilter(input_bytes.Length, false);
49                        pdftron.Filters.FilterWriter writer = new pdftron.Filters.FilterWriter(memoryFilter);
50                        writer.WriteBuffer(input_bytes);
51                        writer.Flush();
52                        memoryFilter.SetAsInputFilter();
53                        PDFDoc pdfdoc = new PDFDoc();
54                        pdftron.PDF.Convert.OfficeToPDF(pdfdoc, memoryFilter, null);
55                        log.LogInformation("Saving output as bytes ...");
56                        output_bytes = pdfdoc.Save(SDFDoc.SaveOptions.e_linearized);
57                        log.LogInformation("Converting output bytes to base64 string and send a response ...");
58                        string base64_str = System.Convert.ToBase64String(output_bytes);
59                        // create json data
60                        var myData = new
61                        {
62                            type = "File",
63                            title = "Transfer base64 encoded Office2PDF output.",
64                            file = new
65                            {
66                                encoding = "base64",
67                                data = base64_str,
68                                fileName = "docx2pdf.pdf",
69                                contentType = "application/pdf"
70                            }
71                        };
72                        // transform it to Json object
73                        json_data = JsonConvert.SerializeObject(myData);
74                        log.LogInformation($"data: {myData}");
75                    }
76                }
77                catch (Exception ex)
78                {
79                    log.LogInformation("No data is sent!");
80                }
81                log.LogInformation("Sending response to the request ...");
82                string responseMessage = !string.IsNullOrEmpty(json_data) ? json_data : $"Hello! PDFNet version = {PDFNet.GetVersion()}. This HTTP triggered function executed successfully.";
83                return new OkObjectResult(responseMessage);
84            }
85            catch (Exception ex)
86            {
87                log.LogInformation($"Error occured: {ex.Message}");
88                return new OkObjectResult("Exception occurred!");
89            }
90        }
91    }
92}

The last step is to publish your Azure function and have it running and its url ready. Make sure to set Settings/Configuration/General settings/Platform to 64-bit in Azure portal.

Testing

In order to use this Azure function to convert an office document to PDF, the client needs to post a REST API request to the server. The request must include json data structured as in C# code above.

Python

1json_data = {
2            "file": {
3                "encoding": "base64",
4                "data": base64_string_of_your_office_document,
5                "filename": filename,
6                "content-type": "application/pdf"
7            }
8        }

Upon receiving a client's request, a response will be sent back to the client including the base64 encoded pdf output using the same json structure. All the client needs to do now is decode the encoded data into pdf. That's it!
You can access the sample python code on Github. After cloning the repository and installing necessary packages, please refer to /client/README.txt for detailed instructions. Navigate to the client folder, run the following command, and see the reponse to client's request in the console and check the output in the output folder:

sh

1python AzureExample.py --url <YOUR PUBLISHED FUNCTION URL>

The client will send a REST API request to convert /input/simple-word_2007.docx to pdf and the server will send back the encoded data, which will then be saved as pdf in the output folder.

You can experiment with your own office document by putting it inside input folder:

sh

1python AzureExample.py --url <YOUR PUBLISHED FUNCTION URL> --filename <YOUR OFFICE FILENAME>

We have shown how to set an Azure function using Apryse SDK. You can now experiment making your own functions, URLs, and can fully utilize Apryse SDK. If your have any questions, please don't hesitate to contact us!

Linux .NET PDF library integration

Info

For Alpine Linux-specific instructions, see the Alpine Linux guide.

Prerequisites

Before you start:

Install Visual Studio Code or another code editor to develop and debug your code.
Install the latest version of .NET to build your application. See the Ubuntu for Developers how-to guide. To install different runtimes or SDKs, see Installing .NET components and available .NET versions.
Download the Apryse .NET PDF library for Linux. Select the file that matches your processor architecture (ARM, AMD, or Intel).
Get your Apryse trial key.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run Apryse SDK in production.

A commercial license key is required for use in a production environment. Contact sales to purchase a commercial license key.

Keep your commercial license key confidential.

License keys are uniquely generated and strictly confidential. Don't publish or store them in any public location, including public GitHub repositories.

1. Convert DOCX to PDF

Download the Linux tarball file for your processor. We'll use the .NET Core (64-bit) Linux file.
Right-click the downloaded PDFNetC64.tar.gz tarball file and select Extract to....
Select Home, New Folder, and then enter ApryseSamples as the folder name.
Click Create, then Select to extract the tarball into your new ApryseSamples folder to run the samples. Use a different location if preferred.
To add your license, navigate to this file and double-click to open:

Text

1~/ApryseSamples/PDFNetC64/Samples/LicenseKey/CS/LicenseKey.cs

6. Go to the private static string key = “YOUR_PDFTRON_LICENSE_KEY”; line and replace the quoted text with your trial license key. Don't change any other information in this file. Save your changes.

C#

LicenseKey.cs

1public static class PDFTronLicense
2{
3    // Add your trial license key here
4    private static string key = "YOUR_PDFTRON_LICENSE_KEY";
5    public static string Key
6    {
7        get
8        {
9            if (key == "YOUR_PDFTRON_LICENSE_KEY" || key == "")
10                throw (new System.Exception("Please enter your license key by replacing \"YOUR_PDFTRON_LICENSE_KEY\" that is assigned to the static string key variable in Samples/LicenseKey/CS/LicenseKey.cs. If you do not have a license key, please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key."));
11            return key;
12        }
13    }
14}
15

7. To run the sample, navigate to this folder:

Text

1~/ApryseSamples/PDFNetC64/Samples/OfficeToPDFTest/CS

Info

The folder path may vary depending on the architecture and tarball you downloaded (for example, x86‑64 vs. ARM64).

8. Right-click the CS folder, then select Open in Terminal.

9. In the terminal, run this script:

Bash

1chmod +x RunTest.sh
2./RunTest.sh

When you run the RunTest.sh script, the sample loads a Microsoft Office document, converts it to PDF, saves the PDF, and outputs the following status messages to the console. For more details, review the OfficeToPDFsample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

Bash

1PDFNet is running in demo mode.
2PackageV2: base
3PackageV2: office_conversion
4Saved Fishermen.pdf
5Saved the_rime_of_the_ancient_mariner.pdf
6Saved factsheet_Arabic.pdf
7Done.

10. Go to this directory to verify the output PDF files are present:

Text

1~/ApryseSamples/PDFNetC64/Samples/TestFiles/Output

The folder structure looks similar to:

Text

1Samples/TestFiles/Output/
2├── factsheet_Arabic.pdf
3├── Fishermen.pdf
4├── the_rime_of_the_ancient_mariner.pdf

11. Open the PDF files to see the converted output. The original DOCX files are located in the PDFNetC64/Samples/TestFiles folder.

Converted PDF file showing the output generated from a DOCX document

2. Create a .NET PDF app

Set up your project

Set up your project by creating a folder and preparing your workspace for the application.

Go to your Home directory and create a new NewApryseProject folder.
Right-click the NewApryseProject folder and select Open in Terminal.
In your terminal, create a new .NET console application:

Bash

1dotnet new console

A successful output looks similar to:

Bash

1The template "Console App" was created successfully.
2
3Processing post-creation actions...
4Restoring <project-path>/<project-name>.csproj:
5  Restore succeeded.

Add the SDK to your app

Next, integrate the Apryse Server SDK into your .NET application and add the code needed to generate a PDF.

From the ~/NewApryseProject directory, run one of the following commands based on your system architecture to install the Apryse SDK:

Bash

1# Choose ONE of the following based on your system architecture:
2
3# Run to add the PDFTron .NET package for x64 (Intel/AMD) systems
4dotnet add package PDFTron.NET.x64
5
6# Run to add the PDFTron .NET package for ARM64 systems
7dotnet add package PDFTron.NET.ARM

The command downloads the .NET package from NuGet and makes the library available to your application. A successful output looks like:

Bash

1Build succeeded.
2
3info : Adding PackageReference for package 'PDFTron.NET.ARM' into project ...
4info : Installed PDFTron.NET.ARM <version>.
5info : PackageReference for package 'PDFTron.NET.ARM' version '<version>' added ...
6log  : Restored <project-path>/<project-name>.csproj.

2. Open the Program.cs file in Visual Studio Code or your preferred code editor:

Text

1~/NewApryseProject/Program.cs

3. Replace Program.cs with the following code, update your license key, and save your changes.

C#

Program.cs

1// Import namespaces
2using System;
3using pdftron.Common;
4using pdftron.PDF;
5using pdftron.SDF;
6
7// Create console app entry point
8namespace myApp
9{
10    class Program
11    {
12      static void Main(string[] args)
13      {
14          Console.WriteLine("Hello World!");
15          
16          // Initialize Apryse SDK
17          // Replace with your demo license key
18          pdftron.PDFNet.Initialize("YOUR_LICENSE_KEY");
19
20          using(PDFDoc doc = new PDFDoc()){
21
22            // Start a new page
23            Page page = doc.PageCreate();
24
25            // Add page to document
26            doc.PagePushBack(page);       
27
28            // Save document as a linearized PDF
29            doc.Save("output.pdf", SDFDoc.SaveOptions.e_linearized); // Save document as a linearized PDF
30
31          }
32      }
33    }
34}

Info

If you're signed in with an Apryse account, your license key is automatically prepopulated in all code snippets.

With this code, you can:

Initialize the system by logging a startup message.
Import the .NET SDK.
Define an asynchronous Main function to generate the PDF, while the PDFNet engine handles license initialization and cleanup.
Log errors and, once processing is complete, release PDFNet resources and shut down the engine.

Run and verify your setup

Finally, build and run your application to confirm that the Apryse Server SDK is working correctly. After the application runs successfully, it will generate a blank PDF file locally.

Navigate to the Home > NewApryseProject folder, and right-click to select Open in Terminal.
In the terminal, build and launch the application:

Bash

1dotnet run

A successful output looks similar to:

Bash

1Hello World!
2
3PDFNet is running in demo mode.
4PackageV2: base

3. Navigate to the Home > NewApryseProject folder.

4. Verify the blank output.pdf file was generated programmatically using the Apryse Server SDK. The folder structure looks similar to:

Text

1NewApryseProject/
2├── bin/
3├── obj/
4├── NewApryseProject.csproj
5├── output.pdf
6└── Program.cs

Now that you've successfully run an OfficeToPDFTest sample (in section 1) and integrated the Apryse Server SDK .NET PDF library into your application, you can try out 50+ samples depending on your needs.

File explorer window on a Linux system showing the Apryse Samples library installed

You can try over fifty samples for the Apryse Server SDK.

To try additional samples, go to section 1. Convert DOCX to PDF > step 7, and choose another sample to run.

macOS .NET PDF Library integration

Prerequisites

Before you start:

Install Visual Studio Code or another code editor to develop and debug your code.
Install the latest active version of the .NET SDK to build your application.
Download the Apryse .NET PDF library for macOS.
Get your Apryse trial key.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run Apryse SDK in production.

A commercial license key is required for use in a production environment. Contact sales to purchase a commercial license key.

Keep your commercial license key confidential.

License keys are uniquely generated and strictly confidential. Don't publish or store them in any public location, including public GitHub repositories.

1. Convert DOCX to PDF

Download the PDFNetCMac.zip file.
Double-click the downloaded PDFNetCMac.zip file to unzip it.
In your Documents folder, create a new ApryseSamples folder for the sample files. Use a different location if preferred.
Move the unzipped PDFNetCMac folder to the new ApryseSamples folder.
In your terminal, go to the ~/Documents/ApryseSamples directory and remove the quarantine attribute from all files so the sample can run:

Bash

1cd Documents/ApryseSamples
2sudo xattr -dr com.apple.quarantine .

Info

Instead of using the terminal, go to System Settings > Privacy & Security and click Open Anyway. For more, see opening an app on a Mac.

6. To add your license, open this file in Visual Studio Code:

Text

1~/Documents/ApryseSamples/PDFNetCMac/Samples/LicenseKey/CS/LicenseKey.cs

7. Go to the private static string key = “YOUR_PDFTRON_LICENSE_KEY”; line and replace the quoted text with your trial license key. Don't change any other information in this file. Save your changes.

C#

LicenseKey.cs

1public static class PDFTronLicense
2{
3    // Add your trial license key here
4    private static string key = "YOUR_PDFTRON_LICENSE_KEY";
5    public static string Key
6    {
7        get
8        {
9            if (key == "YOUR_PDFTRON_LICENSE_KEY" || key == "")
10                throw (new System.Exception("Please enter your license key by replacing \"YOUR_PDFTRON_LICENSE_KEY\" that is assigned to the static string key variable in Samples/LicenseKey/CS/LicenseKey.cs. If you do not have a license key, please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key."));
11            return key;
12        }
13    }
14}

8. To run the sample, navigate to this folder:

Text

1~/Documents/ApryseSamples/PDFNetCMac/Samples/OfficeToPDFTest/CS

9. Right-click the CS folder and select New Terminal at Folder.

10. In the terminal, run this script:

Bash

1chmod +x RunTest.sh
2./RunTest.sh

When you run the RunTest.sh script, the sample loads a Microsoft Office document, converts it to PDF, saves the PDF, and outputs the following status messages to the console. For more details, review the OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

Bash

1PDFNet is running in demo mode.
2Saved fishermen.pdf
3Saved the_rime_of_the_ancient_mariner.pdf
4Saved factsheet_Arabic.pdf
5Done.

11. Go to this directory to verify the output PDF files are present:

Text

1~/Documents/ApryseSamples/PDFNetCMac/Samples/OfficeToPDFTest/CS

The folder structure looks similar to:

Text

1Samples/TestFiles/Output/
2├── factsheet_Arabic.pdf
3├── Fishermen.pdf
4├── the_rime_of_the_ancient_mariner.pdf

12. Open the PDF files to see the converted output. The original DOCX files are located in the PDFNetCMac/Samples/TestFiles folder.

Converted PDF file showing the output generated from a DOCX document

2. Create a .NET PDF app

Set up your project

Set up your project by creating a folder and preparing your workspace for the application.

Go to your Documents folder and create a new NewApryseProject folder.
Right-click the NewApryseProject folder and select New Terminal at Folder.
In your terminal, create a new .NET console application:

Bash

1dotnet new console

A successful output looks similar to:

Bash

1The template "Console App" was created successfully.
2
3Restore succeeded.

Add the SDK to your app

Next, integrate the Apryse Server SDK into your .NET application and add the code needed to generate a PDF.

From the ~/Documents/NewApryseProject directory, install the Apryse SDK:

Bash

1dotnet add package PDFTron.NET.x64

The command downloads the .NET package from NuGet and makes the library available to your application. A successful output looks like:

Bash

1Build succeeded.
2
3Adding PackageReference for package 'PDFTron.NET.x64' to project...
4  GET https://api.nuget.org/v3/index.json
5  OK  https://api.nuget.org/v3/index.json
6
7Restoring packages...
8  Installed PDFTron.NET.x64 x.x.x.
9
10Generating build files...
11Restore succeeded.

2. Open the Program.cs file in Visual Studio Code or your preferred code editor:

Text

1~/Documents/NewApryseProject/Program.cs

3. Replace Program.cs with the following code, update your license key, and save your changes:

C#

Program.cs

1// Import namespaces
2using System;
3using pdftron.Common;
4using pdftron.PDF;
5using pdftron.SDF;
6
7// Create console app entry point
8namespace myApp
9{
10    class Program
11    {
12        static void Main(string[] args)
13        {
14            Console.WriteLine("Hello World!");
15
16            // Initialize Apryse SDK
17            // Replace with your demo license key
18            pdftron.PDFNet.Initialize("YOUR_LICENSE_KEY");
19
20            using (PDFDoc doc = new PDFDoc())
21            {
22                // Start a new page
23                Page page = doc.PageCreate();
24
25                // Add page to document
26                doc.PagePushBack(page);
27
28                // Save document as a linearized PDF
29                doc.Save("output.pdf", SDFDoc.SaveOptions.e_linearized);
30            }
31        }
32    }
33}
34

Info

If you're signed in with an Apryse account, your license key is automatically prepopulated in all code snippets.

With this code, you can:

Initialize the system by logging a startup message.
Import the .NET SDK.
Define an asynchronous Main function to generate the PDF, while the PDFNet engine handles license initialization and cleanup.
Log errors and, once processing is complete, release PDFNet resources and shut down the engine.

Run and verify your setup

Finally, build and run your application to confirm that the Apryse Server SDK is working correctly. After the application runs successfully, it will generate a blank PDF file locally.

Navigate to Documents > NewApryseProject folder, and right-click to select Open in Terminal.
In the terminal, build and launch the application:

Bash

1dotnet run

A successful output looks similar to:

Bash

1Hello World!
2
3PDFNet is running in demo mode.
4PackageV2: base

3. Navigate to the Documents > NewApryseProject folder.

4. Verify the blank output.pdf file was generated programmatically using the Apryse Server SDK. The folder structure looks similar to:

Text

1NewApryseProject/
2├── bin/
3├── obj/
4├── NewApryseProject.csproj
5├── output.pdf
6└── Program.cs

File explorer window on a macOS system showing the Apryse Samples library installed

You can try over fifty samples for the Apryse Server SDK.

To try additional samples, go to section 1. Convert DOCX to PDF > step 8 and choose another sample to run.

Next Steps

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales