QuestPDF 2024.12.1

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

// Install QuestPDF as a Cake Tool
#tool nuget:?package=QuestPDF&version=2024.12.1                

QuestPDF Homepage Getting started tutorial API reference Patterns and Practices GitHub Repo stars Nuget version Nuget download

QuestPDF is a modern open-source .NET library for PDF document generation. Offering comprehensive layout engine powered by concise and discoverable C# Fluent API. Easily generate PDF documents, reports, invoices, exports etc.

Usage animation of the PDF library

👨‍💻 Design PDF documents using C# and employ a code-only approach. Utilize your version control system to its fullest potential.

🧱 Compose PDF document with a range of powerful and predictable structural elements, such as text, image, border, table, and many more.

⚙️ Utilize a comprehensive layout engine, specifically designed for PDF document generation and paging support.

📖 Write code using concise and easy-to-understand C# Fluent API. Utilize IntelliSense to quickly discover available options.

🔗 Don't be limited to any proprietary scripting language or format. Follow your experience and leverage all modern C# features.

⌛ Save time thanks to a hot-reload capability, allowing real-time PDF document preview without code recompilation.

Simplicity is the key

How easy it is to start and prototype with QuestPDF? Really easy thanks to its minimal API! Please analyse the code below that generates basic PDF document:

using QuestPDF.Fluent;
using QuestPDF.Helpers;
using QuestPDF.Infrastructure;

// code in your main method
Document.Create(container =>
{
    container.Page(page =>
    {
        page.Size(PageSizes.A4);
        page.Margin(2, Unit.Centimetre);
        page.Background(Colors.White);
        page.DefaultTextStyle(x => x.FontSize(20));
        
        page.Header()
            .Text("Hello PDF!")
            .SemiBold().FontSize(36).FontColor(Colors.Blue.Medium);
        
        page.Content()
            .PaddingVertical(1, Unit.Centimetre)
            .Column(x =>
            {
                x.Spacing(20);
                
                x.Item().Text(Placeholders.LoremIpsum());
                x.Item().Image(Placeholders.Image(200, 100));
            });
        
        page.Footer()
            .AlignCenter()
            .Text(x =>
            {
                x.Span("Page ");
                x.CurrentPageNumber();
            });
    });
})
.GeneratePdf("hello.pdf");

Minimal PDF example

Let's get started

Begin exploring the QuestPDF library today. You are 250 lines of C# code away from creating a fully functional PDF invoice implementation.

Read the Getting Started tutorial to familiarize yourself with general library architecture, important layout structures as well as to better understand helpful patterns and practices.

Easily start designing your PDF documents, reports, invoices, exports and even more.

Getting started tutorial

Example invoice

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 is compatible.  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 net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  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.
  • .NETStandard 2.0

    • No dependencies.
  • net6.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (43)

Showing the top 5 NuGet packages that depend on QuestPDF:

Package Downloads
AgentHub.Service.Financial.Domain.Shared

Package Description

HTMLToQPDF

Relorer.QuestPDF.HTML is an extension for QuestPDF that allows to generate PDF from HTML

DH.QuestPDF

DH框架的Pdf处理库。基于https://github.com/QuestPDF/QuestPDF

Verify.QuestPDF

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

QuestPDF.Markdown

QuestPDF.Markdown is an open-source helper library that allows rendering markdown into a QuestPDF document

GitHub repositories (15)

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

Repository Stars
nopSolutions/nopCommerce
ASP.NET Core eCommerce software. nopCommerce is a free and open-source shopping cart.
beto-rodriguez/LiveCharts2
Simple, flexible, interactive & powerful charts, maps and gauges for .Net, LiveCharts2 can now practically run everywhere Maui, Uno Platform, Blazor-wasm, WPF, WinForms, Xamarin, Avalonia, WinUI, UWP.
Pixeval/Pixeval
Wow. Yet another Pixiv client!
ariacom/Seal-Report
Database Reporting Tool and Tasks (.Net)
neozhu/CleanArchitectureWithBlazorServer
This is a repository for creating a Blazor Server dashboard application following the principles of Clean Architecture
Version Downloads Last updated
2025.1.0-alpha0 1,751 12/4/2024
2024.12.1 20,209 12/9/2024
2024.12.0 11,590 12/4/2024
2024.12.0-rc3 1,055 11/29/2024
2024.12.0-rc2 1,054 11/22/2024
2024.12.0-rc1 160 11/22/2024
2024.12.0-rc0 1,744 11/18/2024
2024.10.4 35,367 11/22/2024
2024.10.3 51,399 11/8/2024
2024.10.2 73,409 10/24/2024
2024.10.1 56,049 10/14/2024
2024.10.0 38,679 10/4/2024
2024.10.0-rc4 2,867 9/26/2024
2024.10.0-rc3 7,664 9/17/2024
2024.10.0-rc2 338 9/16/2024
2024.10.0-rc1 300 9/13/2024
2024.10.0-rc0 3,819 9/4/2024
2024.7.3 173,493 8/27/2024
2024.7.2 130,711 8/1/2024
2024.7.1 66,844 7/22/2024
2024.7.0 37,826 7/15/2024
2024.7.0-rc0 2,020 7/4/2024
2024.6.4 78,271 6/25/2024
2024.6.3 349 6/25/2024
2024.6.2 30,539 6/20/2024
2024.6.1 23,278 6/15/2024
2024.6.0 55,051 6/11/2024
2024.3.10 83,645 5/25/2024
2024.3.9 11,600 5/23/2024
2024.3.8 252 5/23/2024
2024.3.7 23,336 5/20/2024
2024.3.6 37,248 5/14/2024
2024.3.5 26,110 5/12/2024
2024.3.4 28,460 5/6/2024
2024.3.3 10,222 5/2/2024
2024.3.2 39,365 4/25/2024
2024.3.1 35,007 4/22/2024
2024.3.0 67,178 4/12/2024
2024.3.0-rc2 4,308 3/30/2024
2024.3.0-rc1 248 3/29/2024
2024.3.0-rc 631 3/27/2024
2024.3.0-beta1 2,450 3/18/2024
2024.3.0-beta 3,819 2/29/2024
2024.3.0-alpha 1,700 2/15/2024
2023.12.6 300,516 2/21/2024
2023.12.5 76,244 2/7/2024
2023.12.4 154,981 1/15/2024
2023.12.3 21,305 1/12/2024
2023.12.2 66,767 1/1/2024
2023.12.1 72,234 12/15/2023
2023.12.0 54,180 12/3/2023
2023.10.2 87,167 11/13/2023
2023.10.1 46,832 10/31/2023
2023.10.0 33,197 10/23/2023
2023.10.0-alpha0 382 10/13/2023
2023.9.1 48,898 10/6/2023
2023.9.0 38,217 9/25/2023
2023.6.3 151,093 8/27/2023
2023.6.2 644 8/26/2023
2023.6.1 109,014 7/20/2023
2023.6.0 78,820 6/28/2023
2023.5.3 92,903 6/12/2023
2023.5.2 64,159 5/31/2023
2023.5.1 29,263 5/22/2023
2023.5.0 12,694 5/15/2023
2023.4.2 14,455 5/9/2023
2023.4.1 4,995 5/4/2023
2023.4.0 1,657 5/4/2023
2022.12.15 265,439 2/7/2024
2022.12.14 35,241 1/12/2024
2022.12.13 9,846 1/1/2024
2022.12.12 24,808 12/15/2023
2022.12.11 23,596 12/3/2023
2022.12.10 12,260 11/13/2023
2022.12.9 3,446 10/31/2023
2022.12.8 26,588 10/23/2023
2022.12.7 98,942 10/6/2023
2022.12.6 480,016 5/9/2023
2022.12.5 156,574 4/27/2023
2022.12.4 35,303 4/22/2023
2022.12.3 77,675 4/16/2023
2022.12.2 335,583 3/12/2023
2022.12.1 598,453 1/13/2023
2022.12.0 161,549 12/14/2022
2022.11.0 399,533 11/5/2022
2022.11.0-alpha1 364 11/1/2022
2022.11.0-alpha0 324 10/28/2022
2022.9.1 96,998 10/15/2022
2022.9.0 144,674 9/18/2022
2022.9.0-alpha1 307 9/16/2022
2022.8.2 168,658 8/21/2022
2022.8.1 21,032 8/19/2022
2022.8.0 101,947 8/15/2022
2022.6.3 56,570 7/18/2022
2022.6.2 131,659 6/22/2022
2022.6.1 23,553 6/12/2022
2022.6.0 169,589 6/12/2022
2022.6.0-prerelease 1,772 5/30/2022
2022.5.0 290,909 5/9/2022
2022.4.1 117,657 4/8/2022
2022.4.0 72,170 4/4/2022
2022.4.0-alpha1 341 3/27/2022
2022.4.0-alpha0 309 3/27/2022
2022.3.1 100,154 3/15/2022
2022.3.0 2,648 3/14/2022
2022.2.7 1,773 3/12/2022
2022.2.6 6,597 3/8/2022
2022.2.5 20,859 2/18/2022
2022.2.4 716 2/18/2022
2022.2.3 11,502 2/7/2022
2022.2.2 2,070 2/1/2022
2022.2.1 1,630 1/30/2022
2022.2.0 1,912 1/29/2022
2022.2.0-beta1 337 1/24/2022
2022.1.0 26,937 1/10/2022
2022.1.0-beta5 990 1/7/2022
2022.1.0-beta4 348 1/6/2022
2022.1.0-beta3 319 1/5/2022
2022.1.0-beta2 336 1/5/2022
2022.1.0-beta1 338 1/3/2022
2022.1.0-beta0 316 12/30/2021
2022.1.0-alpha0 364 12/30/2021 2022.1.0-alpha0 is deprecated because it is no longer maintained.
2021.12.0 33,286 12/6/2021
2021.12.0-alpha1 1,166 11/29/2021
2021.12.0-alpha0 393 11/18/2021
2021.11.4 23,054 11/14/2021
2021.11.3 4,937 11/7/2021
2021.11.0-beta3 405 11/3/2021
2021.11.0-beta2 436 10/28/2021
2021.11.0-beta 469 10/23/2021
2021.10.1 10,126 9/30/2021
2021.10.0 620 9/30/2021
2021.10.0-beta.2 280 9/14/2021
2021.10.0-beta 422 9/13/2021
2021.9.3 6,643 9/12/2021
2021.9.2 739 9/1/2021
2021.9.1 570 9/1/2021
2021.9.0 536 8/30/2021
2021.8.0 2,503 8/2/2021
2021.5.2 3,372 5/5/2021
2021.4.0 781 4/2/2021
2021.3.1 7,137 3/1/2021
2021.3.0 596 3/1/2021
2021.2.0 641 2/8/2021
2021.1.0 707 1/4/2021
2020.11.0 11,190 11/1/2020

Version 2024.12.0

This release introduces several long-awaited features releated to document operations such as:
- Assemble: Rearrange, select, and remove specific pages within a document.
- Merge: Combine multiple PDF files into a single document.
- Add Attachments: Embed additional files (such as text or images) as attachments within the PDF.
- Underlay and Overlay: Apply other PDF as a background (underlay) or foreground (overlay) to another, adding layered content.
- Linearize: Optimize files for fast web viewing, allowing compatible PDF readers to display the document before it’s fully downloaded.
- Encrypt with Access Restrictions: Secure PDFs with user and owner passwords, applying access controls (like permissions for printing, filling forms, extracting or modifying content).

These features are built using the qpdf library, available under the "Apache-2.0" license.
The qpdf library is available at: https://github.com/qpdf/qpdf
We extend our thanks to the authors of qpdf for their contributions to the open-source community.


Further improvements:
- Adjusted the default path for loading font files to prevent rare application hangs in certain environments
- Performance optimization: improved scalability by limiting the maximum level of parallelism
- Performance optimization for legacy .NET Framework: collect stack trace only when running with the Companion App
- TextBlock: slightly reduced memory usage


Version 2024.12.1
- Fixed: The library now provides hints when an additional dependency is required.
- Improved license-related exception.