ComPDF SDK for .NET Core

As part of the KDAN ecosystem, ComPDF SDK for .NET Core offers comprehensive functions for quickly generating, viewing, annotating, editing, and signing PDFs. It is feature-rich and battle-tested, making PDF files process and manipulation easier and faster.

If you find this library helpful, please consider giving us a ⭐ Star on GitHub! Have feedback or questions? Join the conversation in our Discussions.

Why ComPDF SDK for .NET Core?

• Easy to Integrate: Integrate PDF functionalities easily with our powerful SDK and clear documentation and guides with few lines of code.

• Fully Customizable UI: Design a unique interface for your products with fully customizable UI source code by a high-performing SDK.

• Comprehensive PDF Features: Supports generation, viewing, annotation, page editing, content editing, conversion, OCR, redaction, signing, forms, parsing, measurement, compression, comparison, color separation, batch processing, and more.

• Faster Time-to-Market: Comprehensive SDK libraries save your time and expenses and roll out your applications and projects.

• High-quality Service: We provide 24/7 professional one-to-one technical support, including onsite service and remote assistance via phone and email.

---

Table of Contents

• Related
• [Get Started for Windows](#Get Started for Windows)
• [Get Started for Linux](#Get Started for Linux)
• [Get Started for macOS](#Get Started for macOS)
• Support
• Free Trial & License
• Changelog

Related

• ComPDF API Library for .Net
• Download ComPDF SDK for .NET Core in Nuget
• How to Build a Windows PDF Viewer or Editor
• Brief Introduction to ComPDF for Windows

---

Get Started for Windows

Requirements

• Visual Studio Make sure that the .NET Core cross-platform development workload and MSBUILD are part of your installation. This guide will use Visual Studio 2022. If you would like to use the NuGet integration for Windows x64 please make sure you have Visual Studio 2017 or later. Note: ComPDF SDK is multi-targeting. Target Frameworks: .NET Core 2.1+, .NET Standard 2.0, .NET 5, .NET 6, .NET 7, .NET 8.

• ComPDF SDK's .NET Core PDF Library for Windows: Please contact us to get the ComPDF SDK for .NET Core.

• ComPDF SDK license Commercial license keys are required for use in production environments. If you do not have a valid license key, please contact us to obtain the license key. License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Run the Samples

1. Open the solution file 'Example. sln' in Visual Studio.
2. Select a sample project in Solution Explorer and set it as the startup project. CS and VB examples are currently available.
3. Build and run the example.

Or you can open the command line tool in the project folder and run the example through the command:

dotnet run

Integrate into Your Application

Integrate Manually

1. Open a new instance of Visual Studio 2022and create a new .NET Core console application project (File > New > Project... ). You can find this under the Visual C# menu. Click on OK and allow the IDE to create the project.

2. Find the Solution Explorer on the right side of the screen. Select the project and press Alt + Enter. This will open the properties tab. Alternatively, you can right click on the project and find the properties option. Select .NET Core 2.1 (or above) as the target framework for your application. If you are using a Windows x64 machine for your .NET Core development, you can use NuGet package manager to get the ComPDF SDK. Otherwise, please integrate the SDK manually.

3. Right-click "Dependencies" and click "Add Project Reference", which will open the "Reference Manager" dialog box. Click the option at the bottom of the dialog box, find the corresponding "ComPDFKit.NET.dll", select it and click Add.

4. In the Solution Explorer, select the project and press Shift + Alt + A. With this you can Add an Existing Item. Alternatively, you can right click on the project and find the Add an existing item... option under the Add submenu. Navigate to the library location again, select the file type as All Files (*.*) and select ComPDFKitNative.dll. Click Add.

5. Select ComPDFKit.NET.dll in the solution explorer. A properties window should appear below. In it, change the Build Action setting to Content and the Copy to Output Directory setting to Copy always. To avoid errors, use the drop-down menus available for those fields.

Integrate with NuGet

1. Perform the first 2 steps of integrating manually.

2. Right click on project Dependencies and click on Manage NuGet Packages.... This will open the NuGet Package Manager

3. Click on the Browse tab near the top of the package manager. In the search bar enter:

   ComPDFKit.NetCore
   

4. Select the ComPDFKit.NetCore package by PDF Tecnologies Inc. and click on the Install button in the panel with the package information. If you're prompted or an external dialog is opened for confirmation, click on Ok. After installation, you will see the reference to the package under Dependencies in Solution Explorer.

Create PDF Document

We have completed all the preparation steps. Now let's use the ComPDF SDK to create a PDF file with a blank page, and replace your Program. cs file with the following code. Note that you need to replace your license in the 'LicenseVerify()' method.

using ComPDFKit.NativeMethod;
using ComPDFKit.PDFDocument;
using Microsoft.Win32;
using System.Reflection.Metadata;
using System.Windows;

namespace ComPDFKit_Demo
{
    public class Program
    {
        private static bool LicenseVerify()
        {
            if (!CPDFSDKVerifier.LoadNativeLibrary())
                return false;
            LicenseErrorCode verifyResult = CPDFSDKVerifier.LicenseVerify("Input your license here");
            return (verifyResult == LicenseErrorCode.E_LICENSE_SUCCESS);
        }

        public static void Main()
        { 
            LicenseVerify();
            CPDFDocument document = CPDFDocument.CreateDocument();
             // Insert to the first page
            int pageIndex = 0;
            int pageWidth = 595;
            int pageHeight = 842;
            //The InsertPage method can specify an image path. When the image path is empty, a blank page will be inserted.
            document.InsertPage(pageIndex, pageWidth, pageHeight, "");
            document.WriteToFilePath("new_file.pdf");// Save the entire document object to the current path.
            Console.WriteLine("Done. Results saved in new_file.pdf");
        }
    }
}

After running the program, please check the output file generated by the program. You will find that a PDF file with blank pages has been generated, and by default, it should be in the bin/Debug directory where your project files are located.

Get Started for Linux

Requirements

• NET Core SDK Note: ComPDF SDK is multi-targeting. Target Frameworks : .NET Core 2.1+, .NET Standard 2.0, .NET 5, .NET 6, .NET 7, .NET 8。

• ComPDFKit 's .NET Core PDF Library for Linux: Please contact us to obtain the ComPDF SDK for NET Core.

• ComPDF SDK license Commercial license keys are required for use in production environments. If you do not have a valid license key, please contact us to obtain the license key. License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Run the Samples

Enter the sample folder and run the example from the command line:

• Input/ Run. sh all to run all examples.
• Input/ Run. shRun a specific example. For example/ Run. sh BatesTest.

If you receive an error message bash:/ Test. sh: Permission denied, you need to enter the following command:

chmod+x run .sh

Integrate into Your Application

You can follow the manual or nuget integration described below for operation. This section will help you build your first ComPDF application. If you can open, save, and close PDFDoc, you can easily integrate the rest of the ComPDF SDK.

Integrate Manually

1. Create a new project named ComPDFKit Demo_ through the console:

   mkdir ComPDFKitDemo
   cd ComPDFKitDemo
   dotnet new console -o "ComPDFKit Demo"

2. Copy the ComPDFKitNative.so file and ComPDF Copy the NET.dll file to the project folder.

3. Add the following code to the. csproj file:

   <ItemGroup>
    <Reference Include="ComPDFKit.NET.dll">
      <HintPath>ComPDFKit.NET.dll</HintPath>
    </Reference>
   </ItemGroup>
   
   <ItemGroup>
       <Content Include="ComPDFKitNative.so">
           <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </Content>
   </ItemGroup>

   Your final ComPDF Demo.csproj file should look like this:

   <Project Sdk="Microsoft.NET.Sdk">
   
       <PropertyGroup>
           <OutputType>Exe</OutputType>
           <TargetFramework>net6.0</TargetFramework>
       </PropertyGroup>
   
       <ItemGroup>
           <Reference Include="ComPDFKit.NET.dll">
               <HintPath>ComPDFKit.NET.dll</HintPath>
           </Reference>
       </ItemGroup>
   
       <ItemGroup>
           <Content Include="ComPDFKitNative.so">
               <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
           </Content>
       </ItemGroup>
   
   </Project>

Integrate with NuGet

1. Create a new project named ComPDFKit Demo_ through the console:

   mkdir ComPDFKitDemo
   cd ComPDFKitDemo
   dotnet new console -o "ComPDFKit Demo"

2. Enter the project folder and install ComPDFKit Core NuGet package:

   dotnet add package ComPDFKit.NetCore

Create PDF Document

We have completed all the preparation steps. Now let's use the ComPDF SDK to create a PDF file with a blank page, and replace your Program. cs file with the following code. Note that you need to replace your license in the 'LicenseVerify()' method.

using ComPDFKit.NativeMethod;
using ComPDFKit.PDFDocument;
using System.Reflection.Metadata;

namespace ComPDFKit_Demo
{
    public class Program
    {
        private static bool LicenseVerify()
        {
            if (!CPDFSDKVerifier.LoadNativeLibrary())
                return false;
            LicenseErrorCode verifyResult = CPDFSDKVerifier.LicenseVerify("Input your license here");
            return (verifyResult == LicenseErrorCode.E_LICENSE_SUCCESS);
        }

        public static void Main()
        { 
            LicenseVerify();
            CPDFDocument document = CPDFDocument.CreateDocument();
            int pageIndex = 0;
            int pageWidth = 595;
            int pageHeight = 842;
            document.InsertPage(pageIndex, pageWidth, pageHeight, "");
            document.WriteToFilePath("new_file.pdf");
            Console.WriteLine("Done. Results saved in new_file.pdf");
        }
    }
}

Now you can run the program from the command line:

dotnet run

Now you will find the 'new_file. pdf' file in the program output directory, which is a PDF file with a blank page.

Get Started for macOS

Requirements

• .NET Core SDK Note: ComPDF SDK is multi-targeting. Target Frameworks : .NET Core 2.1+, .NET Standard 2.0, .NET 5, .NET 6, .NET 7, .NET 8。

• ComPDF's .NET Core PDF Library for macOS: Please contact us to obtain the ComPDF SDK for NET Core.

• ComPDF SDK license Commercial license keys are required for use in production environments. If you do not have a valid license key, please contact us to obtain the license key. License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Run the Samples

Enter the sample folder and run the example from the command line:

• Input/ Run. sh all to run all examples.
• Input/ Run. shRun a specific example. For example/ Run. sh BatesTest.

If you receive an error message bash:/ Test. sh: Permission denied, you need to enter the following command:

chmod +x run.sh

Integrate into your Application

You can follow the manual or nuget integration described below for operation. This section will help you build your first ComPDF application. If you can open, save, and close PDFDoc, you can easily integrate the rest of the ComPDF SDK.

Integrate Manually

1. Create a new project named ComPDFKit Demo_ through the console

   mkdir ComPDFKitDemo
   cd ComPDFKitDemo
   dotnet new console -o "ComPDFKit Demo"
   

2. Copy the libComPDFKit.dylib file and the ComPDFKit.Desk.Core.dll file to the project folder.

3. Add the following code to the .csproj file:

   <ItemGroup>
       <Reference Include="ComPDFKit.NET.dll">
           <HintPath>ComPDFKit.Desk.Core.dll</HintPath>
       </Reference>
   </ItemGroup>
   
   <ItemGroup>
       <Content Include="libComPDFKit.dylib">
           <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </Content>
   </ItemGroup>

   Your final ComPDFKit Demo.csproj file should look like this:

   <Project Sdk="Microsoft.NET.Sdk">
   
       <PropertyGroup>
           <OutputType>Exe</OutputType>
           <TargetFramework>net6.0</TargetFramework>
       </PropertyGroup>
   
       <ItemGroup>
           <Reference Include="ComPDFKit.Desk.Core.dll">
               <HintPath>ComPDFKit.Desk.Core.dll</HintPath>
           </Reference>
       </ItemGroup>
   
       <ItemGroup>
           <Content Include="libComPDFKit.dylib">
               <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
           </Content>
       </ItemGroup>
   
   </Project>

Integrate with NuGet

1. Create a new project named ComPDF Demo in the console:

   mkdir ComPDFKitDemo
   cd ComPDFKitDemo
   dotnet new console -o "ComPDFKit Demo"

2. Go to the project folder and install the ComPDFKit.Core NuGet package:

   dotnet add package ComPDFKit.NetCore

Create PDF Document

We have completed all the preparation steps. Now let us use ComPDF SDK to create a PDF file with a blank page. Replace your Program.cs file with the following code. Note: You need to replace your license into the LicenseVerify() method.

using ComPDFKit.NativeMethod;
using ComPDFKit.PDFDocument;
using System.Reflection.Metadata;

namespace ComPDFKit_Demo
{
    public class Program
    {
        private static bool LicenseVerify()
        {
            if (!CPDFSDKVerifier.LoadNativeLibrary())
                return false;
            LicenseErrorCode verifyResult = CPDFSDKVerifier.LicenseVerify("Input your license here");
            return (verifyResult == LicenseErrorCode.E_LICENSE_SUCCESS);
        }

        public static void Main()
        { 
            LicenseVerify();
            CPDFDocument document = CPDFDocument.CreateDocument(); 
            int pageIndex = 0;
            int pageWidth = 595;
            int pageHeight = 842; 
            document.InsertPage(pageIndex, pageWidth, pageHeight, "");
            document.WriteToFilePath("new_file.pdf");
            Console.WriteLine("Done. Results saved in new_file.pdf");
        }
    }
}

Now you can run the program from the command line:

dotnet run

You will now find the new_file.pdf file in the program output directory, which is a PDF file with a blank page.

Support

ComPDF has a professional R&D team that produces comprehensive technical documentation and guides to help developers. Also, you can get an immediate response when reporting your problems to our support team.

• For detailed information, please visit our Guides page.

• For technical assistance, please reach out to our Technical Support.

• To get more details and an accurate quote, please contact our Sales Team.

Free Trial & License

ComPDF SDK offers a 30-day free trial so you can evaluate core PDF capabilities in your own application.

To get started:

1. Apply for a free trial
2. Review supported trial features and licensing details
3. Follow the integration and license steps above to activate the SDK in your project

For custom deployments, advanced features, or volume licensing, please contact our sales team

Changelog

Stay updated with the latest improvements through our Changelog.