PdfPig 0.1.0-beta001

This is a prerelease version of PdfPig.
There is a newer version of this package available.
See the version list below for details.
dotnet add package PdfPig --version 0.1.0-beta001                
NuGet\Install-Package PdfPig -Version 0.1.0-beta001                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PdfPig" Version="0.1.0-beta001" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PdfPig --version 0.1.0-beta001                
#r "nuget: PdfPig, 0.1.0-beta001"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PdfPig as a Cake Addin
#addin nuget:?package=PdfPig&version=0.1.0-beta001&prerelease

// Install PdfPig as a Cake Tool
#tool nuget:?package=PdfPig&version=0.1.0-beta001&prerelease                

This project allows users to read and extract text and other content from PDF files. In addition the library can be used to create simple PDF documents containing text and geometrical shapes.

Migrating to 0.1.x from 0.0.x? Use this guide: migration to 0.1.x.

Get Started

The simplest usage at this stage is to open a document, reading the words from every page:

using (PdfDocument document = PdfDocument.Open(@"C:\Documents\document.pdf"))
{
    foreach (Page page in document.GetPages())
    {
        string pageText = page.Text;

        foreach (Word word in page.GetWords())
        {
            Console.WriteLine(word.Text);
        }
    }
}

To create documents use the class PdfDocumentBuilder. The Standard 14 fonts provide a quick way to get started:

PdfDocumentBuilder builder = new PdfDocumentBuilder();

PdfPageBuilder page = builder.AddPage(PageSize.A4);

// Fonts must be registered with the document builder prior to use to prevent duplication.
PdfDocumentBuilder.AddedFont font = builder.AddStandard14Font(Standard14Font.Helvetica);

page.AddText("Hello World!", 12, new PdfPoint(25, 520), font);

byte[] documentBytes = builder.Build();

File.WriteAllBytes(@"C:\git\newPdf.pdf", documentBytes);

Each font must be registered with the PdfDocumentBuilder prior to use enable pages to share the font resources. Only Standard 14 fonts and TrueType fonts (.ttf) are supported.

Usage

The PdfDocument class provides access to the contents of a document loaded either from file or passed in as bytes. To open from a file use the PdfDocument.Open static method:

using UglyToad.PdfPig;
using UglyToad.PdfPig.Content;

using (PdfDocument document = PdfDocument.Open(@"C:\my-file.pdf"))
{
    int pageCount = document.NumberOfPages;

    // Page number starts from 1, not 0.
    Page page = document.GetPage(1);

    decimal widthInPoints = page.Width;
    decimal heightInPoints = page.Height;

    string text = page.Text;
}

PdfDocument should only be used in a using statement since it implements IDisposable (unless the consumer disposes of it elsewhere).

Encrypted documents can be opened by PdfPig. To provide an owner or user password provide the optional ParsingOptions when calling Open with the Password property defined. For example:

using (PdfDocument document = PdfDocument.Open(@"C:\my-file.pdf",  new ParsingOptions { Password = "password here" }))

You can also provide a list of passwords to try:

using (PdfDocument document = PdfDocument.Open(@"C:\file.pdf", new ParsingOptions 
{ 
    Passwords = new List<string> { "One", "Two" } 
}))

The document contains the version of the PDF specification it complies with, accessed by document.Version:

decimal version = document.Version;

Document Information

The PdfDocument provides access to the document metadata as DocumentInformation defined in the PDF file. These tend not to be provided therefore most of these entries will be null:

PdfDocument document = PdfDocument.Open(fileName);

// The name of the program used to convert this document to PDF.
string producer = document.Information.Producer;
// etc...

Document Structure (0.0.3)

The document now has a Structure member:

UglyToad.PdfPig.Structure structure = document.Structure;

This provides access to tokenized PDF document content:

Catalog catalog = structure.Catalog;
DictionaryToken pagesDictionary = catalog.PagesDictionary;

The pages dictionary is the root of the pages tree within a PDF document. The structure also exposes a GetObject(IndirectReference reference) method which allows random access to any object in the PDF as long as its identifier number is known. This is an identifier of the form 69 0 R where 69 is the object number and 0 is the generation.

Page

The Page contains the page width and height in points as well as mapping to the PageSize enum:

PageSize size = Page.Size;

bool isA4 = size == PageSize.A4;

Page provides access to the text of the page:

string text = page.Text;

There is a new (0.0.3) method which provides access to the words. This uses basic heuristics:

IEnumerable<Word> words = page.GetWords();

Letter

Due to the way a PDF is structured internally the page text may not be a readable representation of the text as it appears in the document. Since PDF is a presentation format, text can be drawn in any order, not necessarily reading order. This means spaces may be missing or words may be in unexpected positions in the text.

To help users resolve actual text order on the page, the Page file provides access to a list of the letters:

IReadOnlyList<Letter> letters = page.Letters;

Letter position is measured in PDF coordinates where the origin is the lower left corner of the page. Therefore a higher Y value means closer to the top of the page.

Annotations (0.0.5)

Early support for retrieving annotations on each page is provided using the method:

page.ExperimentalAccess.GetAnnotations()

This call is not cached and the document must not have been disposed prior to use. The annotations API may change in future.

Bookmarks (0.0.10)

The bookmarks (outlines) of a document may be retrieved at the document level:

bool hasBookmarks = document.TryGetBookmarks(out Bookmarks bookmarks);

This will return false if the document does not define any bookmarks.

Forms (0.0.10)

Form fields for interactive forms (AcroForms) can be retrieved using:

bool hasForm = document.TryGetForm(out AcroForm form);

This will return false if the document does not contain a form.

The fields can be accessed using the AcroForm's Fields property. Since the form is defined at the document level this will return fields from all pages in the document. Fields are of the types defined by the enum AcroFieldType, for example PushButton, Checkbox, Text, etc.

A page has a method to extract hyperlinks (annotations of link type):

IReadOnlyList<UglyToad.PdfPig.Content.Hyperlink> hyperlinks = page.GetHyperlinks();

TrueType (0.1.0)

The classes used to work with TrueType fonts in the PDF file are now available for public consumption. Given an input file:

using UglyToad.PdfPig.Fonts.TrueType;
using UglyToad.PdfPig.Fonts.TrueType.Parser;

byte[] fontBytes = System.IO.File.ReadAllBytes(@"C:\font.ttf");
TrueTypeDataBytes input = new TrueTypeDataBytes(fontBytes);
TrueTypeFont font = TrueTypeFontParser.Parse(input);

The parsed font can then be inspected.

Credit

This project wouldn't be possible without the work done by the PDFBox team and the Apache Foundation. Any bugs in the code are entirely my fault.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 is compatible.  net451 is compatible.  net452 is compatible.  net46 is compatible.  net461 is compatible.  net462 is compatible.  net463 was computed.  net47 is compatible.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (48)

Showing the top 5 NuGet packages that depend on PdfPig:

Package Downloads
OrchardCore.Application.Cms.Core.Targets

Orchard Core CMS is a Web Content Management System (CMS) built on top of the Orchard Core Framework. Converts the application into a modular OrchardCore CMS application with TheAdmin theme but without any front-end Themes.

Microsoft.KernelMemory.Core

The package contains the the core logic and abstractions of Kernel Memory, not including extensions.

OrchardCore.Application.Cms.Targets

Orchard Core CMS is a Web Content Management System (CMS) built on top of the Orchard Core Framework. Converts the application into a modular OrchardCore CMS application with following themes. - TheAdmin Theme - SafeMode Theme - TheAgency Theme - TheBlog Theme - TheComingSoon Theme - TheTheme theme

Tabula

Extract tables from PDF files (port of tabula-java using PdfPig).

FileCurator

FileCurator is a simple manager for your files. It tries to give them a common interface to deal with files whether on your system or other locations.

GitHub repositories (13)

Showing the top 5 popular GitHub repositories that depend on PdfPig:

Repository Stars
OrchardCMS/OrchardCore
Orchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework.
dotnet/docfx
Static site generator for .NET API documentation.
SciSharp/BotSharp
The AI Agent Framework in .NET
microsoft/kernel-memory
RAG architecture: index and query any data using LLM and natural language, track sources, show citations, asynchronous memory patterns.
paillave/Etl.Net
Mass processing data with a complete ETL for .net developers
Version Downloads Last updated
0.1.10-alpha-20241103-132ad 133 11/3/2024
0.1.10-alpha-20241031-d3bf6 166 10/31/2024
0.1.10-alpha-20241026-40af4 327 10/26/2024
0.1.10-alpha-20241019-e1060 483 10/19/2024
0.1.10-alpha-20241018-ea95a 121 10/18/2024
0.1.10-alpha-20241016-e903b 250 10/16/2024
0.1.10-alpha-20241013-f4054 194 10/13/2024
0.1.10-alpha-20241008-a2580 715 10/8/2024
0.1.10-alpha-20241007-c4672 262 10/7/2024
0.1.9 72,851 10/6/2024
0.1.9-alpha-20240930-eb9a1 2,785 9/30/2024
0.1.9-alpha-20240910-4845f 28,462 9/10/2024
0.1.9-alpha-20240909-09bdd 1,057 9/9/2024
0.1.9-alpha-20240904-cd2a8 1,293 9/4/2024
0.1.9-alpha-20240903-f4d14 710 9/3/2024
0.1.9-alpha-20240902-cf45d 589 9/2/2024
0.1.9-alpha-20240901-b824f 129 9/1/2024
0.1.9-alpha-20240821-b4649 5,237 8/21/2024
0.1.9-alpha-20240721-a99c0 19,361 7/21/2024
0.1.9-alpha-20240702-65c64 9,102 7/2/2024
0.1.9-alpha-20240628-bac00 6,479 6/28/2024
0.1.9-alpha-20240626-14e70 936 6/26/2024
0.1.9-alpha-20240625-dc933 594 6/25/2024
0.1.9-alpha-20240612-d2cae 4,321 6/12/2024
0.1.9-alpha-20240609-affc1 912 6/9/2024
0.1.9-alpha-20240601-65a18 2,195 6/1/2024
0.1.9-alpha-20240530-d7e43 752 5/30/2024
0.1.9-alpha-20240510-d86c2 9,503 5/10/2024
0.1.9-alpha-20240509-5a8e6 184 5/9/2024
0.1.9-alpha-20240508-995f2 268 5/8/2024
0.1.9-alpha-20240507-93779 251 5/7/2024
0.1.9-alpha-20240506-b6e03 185 5/6/2024
0.1.9-alpha-20240504-da44e 153 5/4/2024
0.1.9-alpha-20240429-7f42a 4,084 4/29/2024
0.1.9-alpha-20240419-1ef2e 6,792 4/19/2024
0.1.9-alpha-20240413-0f707 8,118 4/13/2024
0.1.9-alpha-20240406-2d6cb 3,464 4/6/2024
0.1.9-alpha-20240402-f6292 6,670 4/2/2024
0.1.9-alpha-20240324-e7896 4,651 3/24/2024
0.1.9-alpha-20240318-69e2b 11,324 3/18/2024
0.1.9-alpha-20240312-845e3 3,090 3/12/2024
0.1.9-alpha-20240307-ac027 1,767 3/7/2024
0.1.9-alpha-20240219-c2536 25,628 2/19/2024
0.1.9-alpha-20240217-f4e75 416 2/17/2024
0.1.9-alpha-20240216-f78b1 333 2/16/2024
0.1.9-alpha-20240215-3bdc9 1,885 2/15/2024
0.1.9-alpha-20240208-19734 4,588 2/8/2024
0.1.9-alpha-20240207-23445 1,369 2/7/2024
0.1.9-alpha-20240128-f886e 6,815 1/28/2024
0.1.9-alpha-20240121-04fc8 8,867 1/21/2024
0.1.9-alpha-20240117-096eb 4,907 1/17/2024
0.1.9-alpha-20240116-4e63e 830 1/16/2024
0.1.9-alpha-20240115-0da7b 868 1/15/2024
0.1.9-alpha-20240114-5953c 447 1/14/2024
0.1.9-alpha-20240112-83519 1,656 1/12/2024
0.1.9-alpha-20240111-88a14 821 1/11/2024
0.1.9-alpha-20240109-8cfaa 8,770 1/9/2024
0.1.9-alpha-20240108-18144 602 1/8/2024
0.1.9-alpha-20231119-4537e 16,792 11/19/2023
0.1.9-alpha-20231113-1bc0e 9,134 11/13/2023
0.1.9-alpha-20231029-17d50 5,385 10/29/2023
0.1.9-alpha-20231026-63096 5,530 10/26/2023
0.1.9-alpha-20231023-ba865 1,932 10/23/2023
0.1.9-alpha-20231019-c6e2d 4,289 10/19/2023
0.1.9-alpha-20230930-06ac8 7,249 9/30/2023
0.1.9-alpha-20230914-d59d2 6,408 9/14/2023
0.1.9-alpha-20230827-ee756 11,889 8/27/2023
0.1.9-alpha-20230806-4a480 8,916 8/6/2023
0.1.8 2,633,175 6/5/2023
0.1.8-alpha-20230605-7fe5f 991 6/5/2023
0.1.8-alpha-20230529-6daa2 6,614 5/29/2023
0.1.8-alpha-20230528-5126d 938 5/28/2023
0.1.8-alpha-20230524-20d3c 3,736 5/24/2023
0.1.8-alpha-20230523-11df5 948 5/23/2023
0.1.8-alpha-20230522-c3dd6 1,353 5/22/2023
0.1.8-alpha-20230423-3898f 37,960 4/23/2023
0.1.8-alpha-20230420-147b8 1,140 4/20/2023
0.1.8-alpha-20230419-2d72d 1,261 4/19/2023
0.1.8-alpha-20230417-cdc3d 1,351 4/17/2023
0.1.8-alpha-20230415-9eb79 1,080 4/15/2023
0.1.8-alpha-20230414-42e41 973 4/14/2023
0.1.8-alpha-20230413-46a04 1,072 4/13/2023
0.1.8-alpha-20230412-db058 1,711 4/12/2023
0.1.8-alpha-20230411-0e39b 1,095 4/11/2023
0.1.8-alpha-20230403-2e062 9,763 4/3/2023
0.1.8-alpha-20230331-bd4ee 18,813 3/31/2023
0.1.8-alpha-20230327-2daba 6,938 3/27/2023
0.1.8-alpha-20230326-58b33 1,101 3/26/2023
0.1.8-alpha-20230324-a3a9d 1,317 3/24/2023
0.1.8-alpha-20230323-a4861 1,117 3/23/2023
0.1.8-alpha-20230320-c024e 1,493 3/20/2023
0.1.8-alpha-20230318-a5c91 1,076 3/18/2023
0.1.8-alpha-20230219-999f9 2,704 2/19/2023
0.1.8-alpha-20230117-88aad 5,244 1/17/2023
0.1.8-alpha-20230109-65bc7 1,508 1/9/2023
0.1.7 766,628 12/13/2022
0.1.7-alpha-20221212-c8874 72,444 12/12/2022
0.1.7-alpha-20221210-2aed9 1,033 12/10/2022
0.1.7-alpha-20220814-2f9a9 6,262 8/14/2022
0.1.7-alpha-20220703-545d1 2,956 7/3/2022
0.1.7-alpha-20220622-fc71a 1,196 6/22/2022
0.1.7-alpha-20220618-f2188 1,053 6/18/2022
0.1.7-alpha-20220525-559f3 4,512 5/25/2022
0.1.7-alpha-20220511-ddab5 2,334 5/11/2022
0.1.7-alpha-20220503-4e490 1,880 5/3/2022
0.1.7-alpha-20220426-03692 1,183 4/26/2022
0.1.6 1,143,564 4/25/2022
0.1.6-alpha-20220425-2576c 1,125 4/25/2022
0.1.6-alpha-20220423-801a3 1,084 4/23/2022
0.1.6-alpha-20220415-cbd02 1,725 4/15/2022
0.1.6-alpha-20220411-09a62 1,216 4/11/2022
0.1.6-alpha-20220405-c2ecb 1,774 4/5/2022
0.1.6-alpha-20220404-6b085 1,070 4/4/2022
0.1.6-alpha-20220315-9c83e 3,878 3/15/2022
0.1.6-alpha-20220220-b0a5f 3,373 2/20/2022
0.1.6-alpha-20220116-e54cd 2,240 1/16/2022
0.1.6-alpha-20220113-5b66e 1,049 1/13/2022
0.1.6-alpha-20220112-b89c8 1,102 1/12/2022
0.1.6-alpha-20220111-41bfa 1,898 1/11/2022
0.1.5 965,722 9/17/2021
0.1.5-alpha002 5,018 5/9/2021
0.1.5-alpha001 25,698 2/28/2021
0.1.5-alpha-20211231-a57e5 2,340 12/31/2021
0.1.5-alpha-20211026-55244 1,087 10/26/2021
0.1.5-alpha-20210929-615e8 1,146 9/29/2021
0.1.5-alpha-20210918-4c36f 1,126 9/18/2021
0.1.5-alpha-20210828-e8f91 1,124 8/28/2021
0.1.5-alpha-20210827-e8f91 1,124 8/27/2021
0.1.5-alpha-20210817-b1f88 1,147 8/17/2021
0.1.4 618,678 11/29/2020
0.1.3 50,193 11/15/2020
0.1.3-alpha001 2,782 9/4/2020
0.1.2 247,246 7/4/2020
0.1.2-alpha003 1,336 6/20/2020
0.1.2-alpha002 3,603 5/10/2020
0.1.2-alpha001 1,374 4/25/2020
0.1.1 132,381 3/18/2020
0.1.1-alpha001 1,366 3/15/2020
0.1.0 201,762 1/13/2020
0.1.0-beta002 1,253 1/8/2020
0.1.0-beta001 1,254 1/6/2020
0.0.11 2,125 12/17/2019
0.0.10 1,773 12/9/2019
0.0.9 109,292 8/13/2019
0.0.7 1,713 8/3/2019
0.0.6 2,736 5/19/2019
0.0.5 17,366 12/30/2018
0.0.3 1,555 11/27/2018
0.0.1 10,594 2/26/2018
0.0.1-alpha-002 1,576 1/21/2018
0.0.1-alpha-001 1,568 1/10/2018