Get Started with the Apryse Server SDK .NET PDF Library Integration

You'll get started with our samples to see the output you can create when you integrate the Apryse Server SDK into your application. You'll also create a project and integrate the Server SDK into your application, using the Linux platform.

Before you start:

• Install Visual Studio Code (or your preferred application) to write, edit, and debug source code. 
• Install .NET on Linux to build your application. You may also need to install .NET SDK.
  • Additional resources
    • how to install using Snap
    • available .NET versions
• Download Apryse’s .NET PDF Library for Linux tarball file. See our Linux developer download section for the file you need based on your processor (ARM, AMD, Intel).
• Get your Apryse trial key.

First, you’ll download and run the OfficeToPDFTest sample which allows you to explore and validate the conversion features offered by the SDK. By running the sample, you can quickly:

• Verify the capabilities.
• Understand how to interact with the MS Office to Conversion PDF API.
• Use it as a reference for integrating similar functionality into your own application.

1. Download the tarball file for Linux suitable for your processor. For this guide, we'll use the Linux Intel file.
2. Use your Linux file explorer to navigate to the Downloads folder, right-click on the tar.gz tarball file, then select Extract to...

Navigate to and extract the tarball file.

3. Select Home, New Folder, then enter ApryseSamples, and click Create to create a new folder to extract the tarball file into for running the samples. You can create a folder at a different location if you prefer, but for this guide’s instructions, we used the location and name above.

The ApryseSamples folder is created and the tarball is extracted to the folder.

Create a new folder for running the samples.

4. Navigate to /Home/ApryseSamples/PDFNetC64/Samples/LicenseKey/CS/LicenseKey.cs and double-click to open so you can add your license key to the LicenseKey.cs file before running the sample.

Add your license key.

5. Scroll down to the line containing private static string key = “YOUR_PDFTRON_LICENSE_KEY”; and replace the words in quotes with the copy of your trial license key.

6. Save your changes and close the file.

Add your trial license key to the LicenseKey.cs file.

7. To run the sample, navigate to the folder you created in step 3 above, /Home/ApryseSamples/PDFNetC64/Samples/OfficeToPDFTest/CS, right-click on the CS folder, then select Open in Terminal.

Run the sample.

8. The Linux terminal opens the OfficeToPDFTest sample. From the project directory, on the command line, enter the following, then press Enter.

1sh RunTest.sh

When you run the sh RunTest.sh command, the sample code loads an Office document, converts the Office document to PDF, saves the resulting PDF, and outputs status messages to the console. For more details, you can look at additional OfficeToPDFsample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

The sample code loads, converts, and saves the resulting PDFs.

Once the sample finishes running, you'll see the status Done in the terminal.

9. At the command prompt, type exit, then press Enter.

10. Go to your Linux file explorer and navigate to: /Home/ApryseSamples/PDFNetC64/Samples/TestFiles/Output. You will see three output PDF files (Fisherman.pdf, the_rime_of_the_ancient_mariner.pdf, and the factsheet_Arabic.pdf):

Three PDF files have been created by running the sample.

11. Open the PDF files to see the converted output. You have successfully run the OfficeToPDFTest conversion sample!

1. In your Linux file explorer, navigate to the Home folder, and select New Folder.

Create a folder for your new project.

2. Enter the folder name, NewApryseProject, then click Create.

Enter the folder name for your new project.

3. Right-click on the NewApryseProject folder and select Open in Terminal.

Select the new project and open in the terminal.

4. From the project directory, on the command line, enter the following and press Enter:

1dotnet new console

A template "Console App" is created for your new project.

Create a new console app in the terminal.

5. On the command line, from your project directory, enter the following and press Enter:

1// Use 'dot net add package PDFTron.NET.ARM' if your system has an ARM processor.
2
3dotnet add package PDFTron.NET.x64

You have successfully added the Apryse Server SDK to your .NET project.

Add the Server package to your project.

6. At the command prompt, type exit and press Enter.

1. Open Visual Studio Code (or your preferred application) and from the File menu, select Open Folder.

Open Visual Studio Code.

2. Navigate to the Home folder, select the NewApryseProject folder and click Open.

Open your new project in Visual Studio Code.

3. The NewApryseProject opens in Visual Studio Code. Navigate to and open the Program.cs file.

Navigate to and open the Program.cs file.

4. Copy the following C# code and paste in into Line 1 of the Program.cs file (replace the existing content in Line 1 of the file).

1using System;
2using pdftron.Common;
3using pdftron.PDF;
4using pdftron.SDF;
5
6namespace myApp
7{
8    class Program
9    {
10      static void Main(string[] args)
11      {
12          Console.WriteLine("Hello World!");
13          pdftron.PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY"); // PDFNet must be initialized before accessing any Apryse API
14
15          using(PDFDoc doc = new PDFDoc()){
16
17            Page page = doc.PageCreate();	// Start a new page
18            doc.PagePushBack(page);       // Add page to document
19            doc.Save("output.pdf", SDFDoc.SaveOptions.e_linearized); // Save document as a linearized PDF
20
21          }
22      }
23    }
24}

5. In the Linux file explorer, navigate to the Home folder. Select the NewApryseProject folder, right-click and select Open in Terminal.

6. From the project directory, on the command line, enter the following, then press Enter.

1dotnet run

The code executes and you will see the message, “Hello World!”

The code runs and you will see the "Hello World!" message.

7. Exit out of the command line and navigate to the Home > NewApryseProject folder.

You will see the output.pdf file that was created.

8. Open the output.pdf which you created by integrating the Apryse Server SDK!

9. Now that you have successfully run an OfficeToPDFTest sample and integrated the Apryse Server SDK .NET PDF Library into your application, you can try out 50+ samples depending on your needs:

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

10. To try additional samples, go to section 1. Run a sample > step 4 above and choose another sample to run.

You'll get started with our samples to see the output you can create when you integrate the Apryse Server SDK into your application. You'll also create a project and integrate the Server SDK into your application, using the macOS platform.

Before you start:

• Install Visual Studio Code (or your preferred application) to write, edit, and debug source code.
• Install .NET on macOS ARM64 to build applications for desktop, web, mobile, cloud-based services, and games.
• Download Apryse’s .NET PDF Library for macOS .zip file: Apryse Server SDK ARM64.
• Get your Apryse trial key.

First, you’ll download and run the OfficeToPDFTest sample which allows you to explore and validate the conversion features offered by the SDK. By running the sample, you can quickly:

• Verify the capabilities.
• Understand how to interact with the MS Office to Conversion PDF API.
• Use it as a reference for integrating similar functionality into your own application.

1. Download the PDFNetCMac.zip file.
2. Use Finder to navigate to the Downloads folder, right-click on PDFNetCMac.zip, and select Open With > Archive Utility.

Navigate to the Downloads folder and right-click on PDFNetCMac.zip.

3. Select Documents, New Folder, enter ApryseSamples, and press Enter to create a new folder to run the samples. The ApryseSamples folder is created. Note that you can create a folder at a different location if you prefer, but for this guide’s instructions, we used the location and name above.

Create the ApryseSamples folder.

4. Go to the Downloads folder, select the PDFNetCMac folder and move it into the new ApryseSamples folder you just created above.

5. Next, to add the license key, navigate to the /Documents/ApryseSamples/PDFNetCMac/Samples/LicenseKey/CS/LicenseKey.cs file and double-click to open it. The license key file should open in Visual Studio Code.

Navigate to the LicenseKey.cs file and double-click to open.

6. Scroll down to the line containing private static string key = “YOUR_PDFTRON_LICENSE_KEY”; and replace the text in quotes with the copy of your trial license key. Save your changes and close the file.

Add your trial license key and save.

7. Navigate to the folder you created in step 3 above, /Documents/ApryseSamples/PDFNetCMac/Samples/OfficeToPDFTest/CS.

8. Right-click on the CS folder, and select New Terminal at Folder. The Mac terminal opens the OfficeToPDFTest sample.

Open the OfficeToPDFTest sample in the terminal.

9. From the project directory, on the command line, enter the following, then  press Enter:

1sh RunTest.sh

When you run the sh RunTest.sh command, the sample code loads an Office document, converts the Office document to PDF, saves the resulting PDF, and outputs status messages to the console. For more details, you can review additional OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

From the project directory, on the command line, run the sh RunTest.sh command.

Once the sample has finished running, you will see Done in the terminal.

10. At the command prompt, type exit, press Enter, and close the terminal window.

11. In Finder,  navigate to: /Documents/ApryseSamples/PDFNetCMac/Samples/TestFiles/Output. You will see three output PDF files (Fisherman.pdf, the_rime_of_the_ancient_mariner.pdf, and the factsheet_Arabic.pdf):

Navigate to the three Sample test files you just created.

12. Open the PDF files to see the converted output. You have successfully run the OfficeToPDFTest conversion sample!

Open the PDF files to see the converted output.

1. In Finder, navigate to the Documents folder and create a New Folder.

Create a New Folder for your own new project.

2. Enter the folder name, NewApryseProject.

Enter the folder name, NewApryseProject.

3. Right-click on the NewApryseProject folder and select New Terminal at Folder.

Select New Terminal at Folder to open the terminal.

4. From the project directory, on the command line, enter the following and press Enter:

1dotnet new console

The template “Console App” is created.

On the command line, enter dotnet new console to create a new Console App.

5. On the command line, enter the following and press Enter:

1dotnet add package PDFTron.NET.x64

You have successfully added the Apryse Server SDK to your .NET project.

You have successfully added the Apryse Server SDK to your .NET project.

6. At the command prompt, type exit, press Enter, and close the window.

1. Open Visual Studio Code (or your preferred application) and from the File menu, select Open Folder.

Open a folder in Visual Studio Code.

2. Navigate to the Documents folder, select the NewApryseProject folder and click Open. The NewApryseProject opens in Visual Studio Code.

Open the NewApryseProject folder in Visual Studio Code.

3. Navigate to and open the Program.cs file.

Open the Program.cs file.

4. Copy the following C# code and paste it into Line 1 of the Program.cs file (replace the existing content in Line 1 of the file) and click Save:

1using System;
2using pdftron.Common;
3using pdftron.PDF;
4using pdftron.SDF;
5
6namespace myApp
7{
8    class Program
9    {
10        static void Main(string[] args)
11        {
12            Console.WriteLine("Hello World!");
13
14            // PDFNet must be initialized before accessing any Apryse API
15            pdftron.PDFNet.Initialize("demo:1760388909312:60233c900300000000889ef86a08c71d995b0f65b89886183220e5b61e");
16
17            using (PDFDoc doc = new PDFDoc())
18            {
19                // Start a new page
20                Page page = doc.PageCreate();
21
22                // Add page to document
23                doc.PagePushBack(page);
24
25                // Save document as a linearized PDF
26                doc.Save("output.pdf", SDFDoc.SaveOptions.e_linearized);
27            }
28        }
29    }
30}
31

5. In Finder, navigate to the Documents folder. Select the NewApryseProject folder, right-click and select Open in Terminal.

6. From the project directory, on the command line, enter the following, then press Enter:

1dotnet run

The code executes and you will see the message, “Hello World!”

After the code executes, you will see "Hello World!"

7. Exit out of the command line and navigate to the Documents > NewApryseProject folder.

Open the output.pdf to see what you created by integrating the Apryse Server SDK.

8. Open the output.pdf which you created by integrating the Apryse Server SDK!

Now that you have successfully run an OfficeToPDFTest sample and integrated the Apryse Server SDK .NET PDF Library into your application, you can try out 50+ samples depending on your needs:

Explore more than 50 samples that you can create and view.

9. To try additional samples, go to section 1. Run a sample > step 4 above and choose another sample to run.