PDFluent 1.0.0

PDFluent for .NET

Source on GitHub · Documentation · Report an issue

C# bindings for the PDFluent PDF engine via P/Invoke over the C API.

Requirements

• .NET targeting: the assembly targets netstandard2.1. Consumer frameworks must be netstandard2.1-compatible: .NET Core 3.0+, .NET 5/6/7/8/9/10, Mono 6.4+, Xamarin.iOS 12.16+, Xamarin.Android 10.0+, Unity 2021.2+. Earlier .NET Framework versions (4.7.x) are no longer supported on the SDK side.
• The native library (libpdf_capi.dylib / libpdf_capi.so / pdf_capi.dll)

Building the Native Library

cargo build -p pdf-capi --release

Quick Start

using PDFluent;

// Open a PDF
using var doc = PdfDocument.Open("input.pdf");
Console.WriteLine($"Pages: {doc.PageCount}");

// Get page dimensions
double width = doc.GetPageWidth(0);
double height = doc.GetPageHeight(0);

// Extract text
string text = doc.ExtractText(0);

// Render page at 150 DPI
RenderedImage img = doc.RenderPage(0, 150.0);
Console.WriteLine($"Image: {img.Width}x{img.Height}");

// Render thumbnail
RenderedImage thumb = doc.RenderThumbnail(0, 200);

// Read metadata
string? title = doc.GetMetadata("Title");

// Get page boxes
PageBox mediaBox = doc.GetMediaBox(0);
Console.WriteLine($"MediaBox: {mediaBox.Width}x{mediaBox.Height}");

Async Support

// Open asynchronously
using var doc = await PdfDocument.OpenAsync("large.pdf");

// Extract text asynchronously
string text = await doc.ExtractTextAsync(0);

// Render asynchronously
RenderedImage img = await doc.RenderPageAsync(0, 150.0);

Password-Protected PDFs

using var doc = PdfDocument.Open("encrypted.pdf", password: "secret");

Open from Bytes

byte[] data = File.ReadAllBytes("input.pdf");
using var doc = PdfDocument.Open(data);

Error Handling

try
{
    using var doc = PdfDocument.Open(invalidBytes);
}
catch (PdfException ex)
{
    Console.WriteLine($"Status: {ex.Status}");
    Console.WriteLine($"Message: {ex.Message}");
}

NuGet Package

The project generates a NuGet package with native library bundling per platform:

• runtimes/win-x64/native/pdf_capi.dll
• runtimes/linux-x64/native/libpdf_capi.so
• runtimes/osx-arm64/native/libpdf_capi.dylib

API Reference

Licence

AGPL-3.0 or a commercial licence, at your option. The AGPL is the default and the complete product: there is no licence key, no activation call and no tier, and every feature works in every build. If you cannot accept the copyleft obligation, the commercial licence is sold yearly and self-service at pdfluent.com/sdk/pricing, in four options: Commercial (per organisation), OEM Startup and OEM (per product), and Priority support (an add-on). The two texts are LICENSE and LICENSE-COMMERCIAL in this package.

Links

• Documentation: https://pdfluent.com/docs
• Pricing: https://pdfluent.com/sdk/pricing
• PDFluent editor (source-available): https://github.com/pdfluent/pdfluent. The free desktop app this SDK powers.
• Built by Innovation Trigger BV