PdfPig 0.1.8

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package PdfPig --version 0.1.8
NuGet\Install-Package PdfPig -Version 0.1.8
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.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PdfPig --version 0.1.8
#r "nuget: PdfPig, 0.1.8"
#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.8

// Install PdfPig as a Cake Tool
#tool nuget:?package=PdfPig&version=0.1.8

PdfPig

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.

This project aims to port PDFBox to C#.

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"))
{
    for (var i = 0; i < document.NumberOfPages; i++)
    {
        // This starts at 1 rather than 0.
        var page = document.GetPage(i + 1);

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

New in v0.0.5 - To create documents use the class PdfDocumentBuilder. Though they are deprecated within the PDF specification 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");

Each font must be registered with the PdfDocumentBuilder prior to use enable pages to share the font resources. Currently 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 page = document.GetPage(1);

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

    string text = page.Text;
}

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

decimal version = document.Version;

Document Creation

New in v0.0.5 - The PdfDocumentBuilder creates a new document with no pages or content. First, for text content, a font must be registered with the builder. Currently this supports Standard 14 fonts provided by Adobe by default and TrueType format fonts.

To add a Standard 14 font use:

public AddedFont AddStandard14Font(Standard14Font type)

Or for a TrueType font use:

AddedFont AddTrueTypeFont(IReadOnlyList<byte> fontFileBytes)

Passing in the bytes of a TrueType file (.ttf). You can check the suitability of a TrueType file for embedding in a PDF document using:

bool CanUseTrueTypeFont(IReadOnlyList<byte> fontFileBytes, out IReadOnlyList<string> reasons)

Which provides a list of reasons why the font cannot be used if the check fails. You should check the license for a TrueType font prior to use, since the compressed font file is embedded in, and distributed with, the resultant document.

The AddedFont class represents a key to the font stored on the document builder. This must be provided when adding text content to pages. To add a page to a document use:

PdfPageBuilder AddPage(PageSize size, bool isPortrait = true)

This creates a new PdfPageBuilder with the specified size. The first added page is page number 1, then 2, then 3, etc. The page builder supports adding text, drawing lines and rectangles and measuring the size of text prior to drawing.

To draw lines and rectangles use the methods:

void DrawLine(PdfPoint from, PdfPoint to, decimal lineWidth = 1)
void DrawRectangle(PdfPoint position, decimal width, decimal height, decimal lineWidth = 1)

The line width can be varied and defaults to 1. Rectangles are unfilled and the fill color cannot be changed at present.

To write text to the page you must have a reference to an AddedFont from the methods on PdfDocumentBuilder as described above. You can then draw the text to the page using:

IReadOnlyList<Letter> AddText(string text, decimal fontSize, PdfPoint position, PdfDocumentBuilder.AddedFont font)

Where position is the baseline of the text to draw. Currently only ASCII text is supported. You can also measure the resulting size of text prior to drawing using the method:

IReadOnlyList<Letter> MeasureText(string text, decimal fontSize, PdfPoint position, PdfDocumentBuilder.AddedFont font)

Which does not change the state of the page, unlike AddText.

Changing the RGB color of text, lines and rectangles is supported using:

void SetStrokeColor(byte r, byte g, byte b)
void SetTextAndFillColor(byte r, byte g, byte b)

Which take RGB values between 0 and 255. The color will remain active for all operations called after these methods until reset is called using:

void ResetColor()

Which resets the color for stroke, fill and text drawing to black.

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;

// The title given to the document
string title = document.Information.Title;
// etc...

Document Structure

New in 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;

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 and is not reliable or well-tested:

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

You can also (0.0.6) access the raw operations used in the page's content stream for drawing graphics and content on the page:

IReadOnlyList<IGraphicsStateOperation> operations = page.Operations;

There is also an early access (0.0.3) API for retrieving the raw bytes of PDF image objects per page:

IEnumerable<XObjectImage> images = page.ExperimentalAccess.GetRawImages();

This API will be changed in future releases.

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;

Credit

This project wouldn't be possible without the work done by the PDFBox team and the Apache Foundation.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 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 (35)

Showing the top 5 NuGet packages that depend on PdfPig:

Package Downloads
OrchardCore.Media The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Orchard Core CMS is a Web Content Management System (CMS) built on top of the Orchard Core Framework. The media module adds media management support.

Tabula

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

Microsoft.DocAsCode.HtmlToPdf The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Package Description

UmbracoCms.UmbracoExamine.PDF The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Umbraco indexing for PDF files using UmbracoExamine

Verify.PdfPig The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Extends Verify (https://github.com/VerifyTests/Verify) to allow verification via PdfPig.

GitHub repositories (12)

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
Index and query any data using LLM and natural language, tracking sources and showing citations.
paillave/Etl.Net
Mass processing data with a complete ETL for .net developers
Version Downloads Last updated
0.1.9-alpha-20240413-0f707 61 4/13/2024
0.1.9-alpha-20240406-2d6cb 1,153 4/6/2024
0.1.9-alpha-20240402-f6292 664 4/2/2024
0.1.9-alpha-20240324-e7896 2,329 3/24/2024
0.1.9-alpha-20240318-69e2b 2,084 3/18/2024
0.1.9-alpha-20240312-845e3 2,608 3/12/2024
0.1.9-alpha-20240307-ac027 1,663 3/7/2024
0.1.9-alpha-20240219-c2536 8,080 2/19/2024
0.1.9-alpha-20240217-f4e75 296 2/17/2024
0.1.9-alpha-20240216-f78b1 246 2/16/2024
0.1.9-alpha-20240215-3bdc9 1,499 2/15/2024
0.1.9-alpha-20240208-19734 2,438 2/8/2024
0.1.9-alpha-20240207-23445 908 2/7/2024
0.1.9-alpha-20240128-f886e 4,122 1/28/2024
0.1.9-alpha-20240121-04fc8 2,963 1/21/2024
0.1.9-alpha-20240117-096eb 2,851 1/17/2024
0.1.9-alpha-20240116-4e63e 753 1/16/2024
0.1.9-alpha-20240115-0da7b 708 1/15/2024
0.1.9-alpha-20240114-5953c 379 1/14/2024
0.1.9-alpha-20240112-83519 1,577 1/12/2024
0.1.9-alpha-20240111-88a14 611 1/11/2024
0.1.9-alpha-20240109-8cfaa 4,807 1/9/2024
0.1.9-alpha-20240108-18144 519 1/8/2024
0.1.9-alpha-20231119-4537e 13,513 11/19/2023
0.1.9-alpha-20231113-1bc0e 4,628 11/13/2023
0.1.9-alpha-20231029-17d50 4,192 10/29/2023
0.1.9-alpha-20231026-63096 3,560 10/26/2023
0.1.9-alpha-20231023-ba865 1,195 10/23/2023
0.1.9-alpha-20231019-c6e2d 1,873 10/19/2023
0.1.9-alpha-20230930-06ac8 6,344 9/30/2023
0.1.9-alpha-20230914-d59d2 4,234 9/14/2023
0.1.9-alpha-20230827-ee756 11,474 8/27/2023
0.1.9-alpha-20230806-4a480 7,149 8/6/2023
0.1.8 1,068,393 6/5/2023
0.1.8-alpha-20230605-7fe5f 917 6/5/2023
0.1.8-alpha-20230529-6daa2 6,423 5/29/2023
0.1.8-alpha-20230528-5126d 879 5/28/2023
0.1.8-alpha-20230524-20d3c 2,581 5/24/2023
0.1.8-alpha-20230523-11df5 881 5/23/2023
0.1.8-alpha-20230522-c3dd6 1,259 5/22/2023
0.1.8-alpha-20230423-3898f 35,410 4/23/2023
0.1.8-alpha-20230420-147b8 1,065 4/20/2023
0.1.8-alpha-20230419-2d72d 1,184 4/19/2023
0.1.8-alpha-20230417-cdc3d 1,287 4/17/2023
0.1.8-alpha-20230415-9eb79 1,029 4/15/2023
0.1.8-alpha-20230414-42e41 907 4/14/2023
0.1.8-alpha-20230413-46a04 1,001 4/13/2023
0.1.8-alpha-20230412-db058 1,646 4/12/2023
0.1.8-alpha-20230411-0e39b 999 4/11/2023
0.1.8-alpha-20230403-2e062 7,005 4/3/2023
0.1.8-alpha-20230331-bd4ee 18,758 3/31/2023
0.1.8-alpha-20230327-2daba 4,931 3/27/2023
0.1.8-alpha-20230326-58b33 1,021 3/26/2023
0.1.8-alpha-20230324-a3a9d 1,179 3/24/2023
0.1.8-alpha-20230323-a4861 1,046 3/23/2023
0.1.8-alpha-20230320-c024e 1,414 3/20/2023
0.1.8-alpha-20230318-a5c91 1,006 3/18/2023
0.1.8-alpha-20230219-999f9 2,535 2/19/2023
0.1.8-alpha-20230117-88aad 4,018 1/17/2023
0.1.8-alpha-20230109-65bc7 1,370 1/9/2023
0.1.7 597,926 12/13/2022
0.1.7-alpha-20221212-c8874 72,255 12/12/2022
0.1.7-alpha-20221210-2aed9 938 12/10/2022
0.1.7-alpha-20220814-2f9a9 5,854 8/14/2022
0.1.7-alpha-20220703-545d1 2,293 7/3/2022
0.1.7-alpha-20220622-fc71a 1,098 6/22/2022
0.1.7-alpha-20220618-f2188 929 6/18/2022
0.1.7-alpha-20220525-559f3 3,808 5/25/2022
0.1.7-alpha-20220511-ddab5 2,243 5/11/2022
0.1.7-alpha-20220503-4e490 1,772 5/3/2022
0.1.7-alpha-20220426-03692 1,084 4/26/2022
0.1.6 966,055 4/25/2022
0.1.6-alpha-20220425-2576c 1,048 4/25/2022
0.1.6-alpha-20220423-801a3 1,000 4/23/2022
0.1.6-alpha-20220415-cbd02 1,532 4/15/2022
0.1.6-alpha-20220411-09a62 1,142 4/11/2022
0.1.6-alpha-20220405-c2ecb 1,689 4/5/2022
0.1.6-alpha-20220404-6b085 997 4/4/2022
0.1.6-alpha-20220315-9c83e 3,625 3/15/2022
0.1.6-alpha-20220220-b0a5f 3,114 2/20/2022
0.1.6-alpha-20220116-e54cd 2,079 1/16/2022
0.1.6-alpha-20220113-5b66e 961 1/13/2022
0.1.6-alpha-20220112-b89c8 1,036 1/12/2022
0.1.6-alpha-20220111-41bfa 1,359 1/11/2022
0.1.5 873,114 9/17/2021
0.1.5-alpha002 4,742 5/9/2021
0.1.5-alpha001 23,989 2/28/2021
0.1.5-alpha-20211231-a57e5 2,238 12/31/2021
0.1.5-alpha-20211026-55244 989 10/26/2021
0.1.5-alpha-20210929-615e8 1,066 9/29/2021
0.1.5-alpha-20210918-4c36f 1,041 9/18/2021
0.1.5-alpha-20210828-e8f91 1,053 8/28/2021
0.1.5-alpha-20210827-e8f91 1,043 8/27/2021
0.1.5-alpha-20210817-b1f88 1,077 8/17/2021
0.1.4 555,983 11/29/2020
0.1.3 44,640 11/15/2020
0.1.3-alpha001 2,541 9/4/2020
0.1.2 220,739 7/4/2020
0.1.2-alpha003 1,272 6/20/2020
0.1.2-alpha002 3,534 5/10/2020
0.1.2-alpha001 1,294 4/25/2020
0.1.1 122,930 3/18/2020
0.1.1-alpha001 1,278 3/15/2020
0.1.0 195,933 1/13/2020
0.1.0-beta002 1,200 1/8/2020
0.1.0-beta001 1,185 1/6/2020
0.0.11 2,019 12/17/2019
0.0.10 1,642 12/9/2019
0.0.9 108,580 8/13/2019
0.0.7 1,607 8/3/2019
0.0.6 2,630 5/19/2019
0.0.5 11,480 12/30/2018
0.0.3 1,483 11/27/2018
0.0.1 9,465 2/26/2018
0.0.1-alpha-002 1,516 1/21/2018
0.0.1-alpha-001 1,507 1/10/2018