QuestPDF 2022.3.1

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

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

Dotnet GitHub Repo stars Nuget version Nuget download License Sponsor project

QuestPDF is an open-source .NET library for PDF documents generation.

It offers a layouting engine designed with a full paging support in mind. The document consists of many simple elements (e.g. border, background, image, text, padding, table, grid etc.) that are composed together to create more complex structures. This way, as a developer, you can understand the behavior of every element and use them with full confidence. Additionally, the document and all its elements support paging functionality. For example, an element can be moved to the next page (if there is not enough space) or even be split between pages like table's rows.

Unlike other libraries, it does not rely on the HTML-to-PDF conversion which in many cases is not reliable. Instead, it implements its own layouting engine that is optimized to cover all paging-related requirements.

Installation

The library is available as a nuget package. You can install it as any other nuget package from your IDE, try to search by QuestPDF. You can find package details on this webpage.

// Package Manager
Install-Package QuestPDF

// .NET CLI
dotnet add package QuestPDF

// Package reference in .csproj file
<PackageReference Include="QuestPDF" Version="2022.3.0" />

Documentation

Getting started tutorial A short and easy to follow tutorial showing how to design an invoice document under 200 lines of code.

API reference A detailed description of behavior of all available components and how to use them with C# Fluent API.

Patterns and Practices Everything that may help you designing great reports and create reusable code that is easy to maintain.

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:

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");

And compare it to the produced PDF file:

invoice

Are you ready for more?

The Fluent API of QuestPDF scales really well. It is easy to create and maintain even most complex documents. Read the Getting started tutorial to learn QuestPDF basics and implement an invoice under 200 lines of code. You can also investigate and play with the code from the example repository.

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 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 is compatible.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 is compatible.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  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.

NuGet packages (20)

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 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 QuestPDF.

A2v10.Pdf.Report

A2v10 Platform PDF report

GitHub repositories (8)

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.
neozhu/CleanArchitectureWithBlazorServer
This is a repository for creating a Blazor Server dashboard application following the principles of Clean Architecture
NickvisionApps/Denaro
Manage your personal finances
axzxs2001/Asp.NetCoreExperiment
原来所有项目都移动到**OleVersion**目录下进行保留。新的案例装以.net 5.0为主,一部分对以前案例进行升级,一部分将以前的工作经验总结出来,以供大家参考!
Version Downloads Last updated
2024.3.0 697 4/12/2024
2024.3.0-rc2 1,495 3/30/2024
2024.3.0-rc1 160 3/29/2024
2024.3.0-rc 431 3/27/2024
2024.3.0-beta1 846 3/18/2024
2024.3.0-beta 2,012 2/29/2024
2024.3.0-alpha 1,200 2/15/2024
2023.12.6 79,242 2/21/2024
2023.12.5 33,451 2/7/2024
2023.12.4 60,747 1/15/2024
2023.12.3 7,018 1/12/2024
2023.12.2 28,814 1/1/2024
2023.12.1 33,666 12/15/2023
2023.12.0 33,472 12/3/2023
2023.10.2 52,712 11/13/2023
2023.10.1 28,711 10/31/2023
2023.10.0 24,473 10/23/2023
2023.10.0-alpha0 311 10/13/2023
2023.9.1 30,649 10/6/2023
2023.9.0 26,174 9/25/2023
2023.6.3 81,864 8/27/2023
2023.6.2 451 8/26/2023
2023.6.1 71,427 7/20/2023
2023.6.0 43,761 6/28/2023
2023.5.3 54,601 6/12/2023
2023.5.2 45,643 5/31/2023
2023.5.1 21,164 5/22/2023
2023.5.0 11,532 5/15/2023
2023.4.2 11,359 5/9/2023
2023.4.1 3,521 5/4/2023
2023.4.0 565 5/4/2023
2022.12.15 16,317 2/7/2024
2022.12.14 10,460 1/12/2024
2022.12.13 4,476 1/1/2024
2022.12.12 10,600 12/15/2023
2022.12.11 7,662 12/3/2023
2022.12.10 6,004 11/13/2023
2022.12.9 2,091 10/31/2023
2022.12.8 3,580 10/23/2023
2022.12.7 52,640 10/6/2023
2022.12.6 337,254 5/9/2023
2022.12.5 122,366 4/27/2023
2022.12.4 23,019 4/22/2023
2022.12.3 65,807 4/16/2023
2022.12.2 235,361 3/12/2023
2022.12.1 466,343 1/13/2023
2022.12.0 131,743 12/14/2022
2022.11.0 325,961 11/5/2022
2022.11.0-alpha1 280 11/1/2022
2022.11.0-alpha0 260 10/28/2022
2022.9.1 76,910 10/15/2022
2022.9.0 120,040 9/18/2022
2022.9.0-alpha1 242 9/16/2022
2022.8.2 146,660 8/21/2022
2022.8.1 20,327 8/19/2022
2022.8.0 75,634 8/15/2022
2022.6.3 48,029 7/18/2022
2022.6.2 117,336 6/22/2022
2022.6.1 21,520 6/12/2022
2022.6.0 136,897 6/12/2022
2022.6.0-prerelease 1,693 5/30/2022
2022.5.0 255,678 5/9/2022
2022.4.1 86,331 4/8/2022
2022.4.0 59,187 4/4/2022
2022.4.0-alpha1 283 3/27/2022
2022.4.0-alpha0 254 3/27/2022
2022.3.1 94,365 3/15/2022
2022.3.0 2,323 3/14/2022
2022.2.7 1,697 3/12/2022
2022.2.6 6,326 3/8/2022
2022.2.5 19,038 2/18/2022
2022.2.4 640 2/18/2022
2022.2.3 10,291 2/7/2022
2022.2.2 1,964 2/1/2022
2022.2.1 1,530 1/30/2022
2022.2.0 1,713 1/29/2022
2022.2.0-beta1 274 1/24/2022
2022.1.0 21,315 1/10/2022
2022.1.0-beta5 923 1/7/2022
2022.1.0-beta4 282 1/6/2022
2022.1.0-beta3 257 1/5/2022
2022.1.0-beta2 271 1/5/2022
2022.1.0-beta1 269 1/3/2022
2022.1.0-beta0 257 12/30/2021
2022.1.0-alpha0 303 12/30/2021
2021.12.0 29,059 12/6/2021
2021.12.0-alpha1 1,105 11/29/2021
2021.12.0-alpha0 330 11/18/2021
2021.11.4 21,466 11/14/2021
2021.11.3 4,680 11/7/2021
2021.11.0-beta3 336 11/3/2021
2021.11.0-beta2 353 10/28/2021
2021.11.0-beta 405 10/23/2021
2021.10.1 9,741 9/30/2021
2021.10.0 550 9/30/2021
2021.10.0-beta.2 248 9/14/2021
2021.10.0-beta 358 9/13/2021
2021.9.3 4,973 9/12/2021
2021.9.2 652 9/1/2021
2021.9.1 494 9/1/2021
2021.9.0 466 8/30/2021
2021.8.0 2,402 8/2/2021
2021.5.2 2,646 5/5/2021
2021.4.0 705 4/2/2021
2021.3.1 7,046 3/1/2021
2021.3.0 511 3/1/2021
2021.2.0 569 2/8/2021
2021.1.0 624 1/4/2021
2020.11.0 9,215 11/1/2020

- Added minimal API to help you quickly start with QuestPDF development and speed up prototyping,
- Improved exception message when desired font type cannot be found (instead of loading default font on Windows and failing with wrong characters on Linux),
- Improved support for custom font types: loading all type faces from a file, respecting true font family, using CSS-like algorithm to find best style match,
- Added support for custom page number formats in the `Text` element, e.g. you can implement roman literal style if required,
- Improved text API to make it more concise,
- Extended support for the `Section` element (previously the `Location` element) by tracking: beginning page number, end page number, page length, page number within location,
- Renaming: the `ExternalLink` element was renamed to the `Hyperlink` element,
- Renaming: the `Location` element was renamed to the `Section` element,
- Renaming: the `InternalLink` element was renamed to the `SectionLink` element,
- Updated homepage and GitHub pages content.