QuestPDF 2022.12.14

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

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

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

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 6,757 4/12/2024
2024.3.0-rc2 1,793 3/30/2024
2024.3.0-rc1 192 3/29/2024
2024.3.0-rc 536 3/27/2024
2024.3.0-beta1 916 3/18/2024
2024.3.0-beta 2,168 2/29/2024
2024.3.0-alpha 1,257 2/15/2024
2023.12.6 95,161 2/21/2024
2023.12.5 36,473 2/7/2024
2023.12.4 63,565 1/15/2024
2023.12.3 7,569 1/12/2024
2023.12.2 29,869 1/1/2024
2023.12.1 35,003 12/15/2023
2023.12.0 34,419 12/3/2023
2023.10.2 55,105 11/13/2023
2023.10.1 29,321 10/31/2023
2023.10.0 25,214 10/23/2023
2023.10.0-alpha0 333 10/13/2023
2023.9.1 31,324 10/6/2023
2023.9.0 26,670 9/25/2023
2023.6.3 84,220 8/27/2023
2023.6.2 480 8/26/2023
2023.6.1 72,656 7/20/2023
2023.6.0 44,276 6/28/2023
2023.5.3 55,772 6/12/2023
2023.5.2 46,492 5/31/2023
2023.5.1 21,512 5/22/2023
2023.5.0 11,608 5/15/2023
2023.4.2 11,573 5/9/2023
2023.4.1 3,579 5/4/2023
2023.4.0 590 5/4/2023
2022.12.15 20,218 2/7/2024
2022.12.14 11,248 1/12/2024
2022.12.13 4,860 1/1/2024
2022.12.12 11,187 12/15/2023
2022.12.11 8,145 12/3/2023
2022.12.10 6,275 11/13/2023
2022.12.9 2,150 10/31/2023
2022.12.8 4,048 10/23/2023
2022.12.7 56,031 10/6/2023
2022.12.6 343,463 5/9/2023
2022.12.5 125,818 4/27/2023
2022.12.4 23,434 4/22/2023
2022.12.3 66,582 4/16/2023
2022.12.2 238,590 3/12/2023
2022.12.1 471,084 1/13/2023
2022.12.0 132,777 12/14/2022
2022.11.0 329,538 11/5/2022
2022.11.0-alpha1 302 11/1/2022
2022.11.0-alpha0 277 10/28/2022
2022.9.1 77,851 10/15/2022
2022.9.0 120,920 9/18/2022
2022.9.0-alpha1 265 9/16/2022
2022.8.2 147,199 8/21/2022
2022.8.1 20,482 8/19/2022
2022.8.0 76,708 8/15/2022
2022.6.3 48,178 7/18/2022
2022.6.2 117,844 6/22/2022
2022.6.1 21,595 6/12/2022
2022.6.0 137,578 6/12/2022
2022.6.0-prerelease 1,716 5/30/2022
2022.5.0 257,504 5/9/2022
2022.4.1 87,217 4/8/2022
2022.4.0 59,684 4/4/2022
2022.4.0-alpha1 306 3/27/2022
2022.4.0-alpha0 271 3/27/2022
2022.3.1 94,718 3/15/2022
2022.3.0 2,354 3/14/2022
2022.2.7 1,717 3/12/2022
2022.2.6 6,349 3/8/2022
2022.2.5 19,120 2/18/2022
2022.2.4 662 2/18/2022
2022.2.3 10,316 2/7/2022
2022.2.2 1,989 2/1/2022
2022.2.1 1,551 1/30/2022
2022.2.0 1,747 1/29/2022
2022.2.0-beta1 296 1/24/2022
2022.1.0 21,424 1/10/2022
2022.1.0-beta5 941 1/7/2022
2022.1.0-beta4 303 1/6/2022
2022.1.0-beta3 275 1/5/2022
2022.1.0-beta2 292 1/5/2022
2022.1.0-beta1 300 1/3/2022
2022.1.0-beta0 280 12/30/2021
2022.1.0-alpha0 326 12/30/2021
2021.12.0 29,532 12/6/2021
2021.12.0-alpha1 1,127 11/29/2021
2021.12.0-alpha0 352 11/18/2021
2021.11.4 21,522 11/14/2021
2021.11.3 4,708 11/7/2021
2021.11.0-beta3 359 11/3/2021
2021.11.0-beta2 375 10/28/2021
2021.11.0-beta 427 10/23/2021
2021.10.1 9,782 9/30/2021
2021.10.0 572 9/30/2021
2021.10.0-beta.2 248 9/14/2021
2021.10.0-beta 375 9/13/2021
2021.9.3 5,021 9/12/2021
2021.9.2 670 9/1/2021
2021.9.1 515 9/1/2021
2021.9.0 485 8/30/2021
2021.8.0 2,437 8/2/2021
2021.5.2 2,686 5/5/2021
2021.4.0 724 4/2/2021
2021.3.1 7,071 3/1/2021
2021.3.0 538 3/1/2021
2021.2.0 591 2/8/2021
2021.1.0 648 1/4/2021
2020.11.0 9,309 11/1/2020

Version 2022.12.0:
Feature: implemented LetterSpacing property for the Text element
Improvement: the Text element API accepts now only string values, objects are not automatically converted anymore
Fix: the Alignment element incorrectly limits size of its child when only one axis is set (horizontal or vertical)
Maintenance: Updated SkiaSharp dependency to 2.88.3

This release was possible thanks to enormous help of AntonyCorbett, thank you!

Version 2022.12.1:
Fixed: loading fonts from embedded resource via the FontManager.RegisterFontFromEmbeddedResource method
Fixed: better layout calculation stability for the Column element
Improvement: exposed missing API method for the Dynamic component, enabling applying more advanced optimizations
Improvement: better API documentation for the Settings.DocumentLayoutExceptionThreshold property

Version 2022.12.2:
Performance improvements in various areas
Text rendering stability improvements
Fixed: the Settings.CheckIfAllTextGlyphsAreAvailable setting does not work correctly

Version 2022.12.3:
Fix: inconsistent text height when using multiple lines with different TextStyles
Improvement: added validation for color arguments
Fix: the inlined element is shown only once in the header but should be repeated on each page

Version 2022.12.4:
Fix: the TextStyle.Fallback property incorrectly inherits parent's and global properties
Improvement: updated the CreateNotMatchingFontException message to mention that the glyph checking operation can be disabled with the Settings.CheckIfAllTextGlyphsAreAvailable setting

Version 2022.12.6:
Fix: fixed the rendering order of table cells in certain scenarios

Version 2022.12.7:
- Text rendering enhancement: a fake underline is drawn when the font typeface lacks an underline effect configuration or it is unavailable on runtime operating system
- Text rendering enhancement: a fake strikethrough is drawn when the font typeface lacks a strikethrough effect configuration or it is unavailable on runtime operating system
- Text rendering enhancement: a fake skew operation is applied to mimic an italic effect when the provided font lacks an italic variant
- Text rendering enhancement: a fake bold effect is applied when the font doesn't offer variants of higher weight

Version 2022.12.8:
- Updated SkiaSharp dependency from 2.88.3 to 2.88.6
- Updated QuestPDF Previewer dependencies: from Avalonia 0.10.X to 11.0.X

Version 2022.12.9:
- Enhanced developer experience by refining the accuracy of the exception message thrown when native SkiaSharp dependencies are unavailable in the runtime environment.

Version 2022.12.10
- Enhanced SkiaSharp native dependency detection for increased compatibility.
- Fixed rare instances of text rendering inaccurately due to cache-related faults.
- Fixed a rare problem where the Row element does not always respect layout issues in its children.

Version 2022.12.11
- Back-ported feature as part of extended support: simplified development loop by introducing cross-platform methods GeneratePdfAndShow() and GenerateXpsAndShow()
- Back-ported community-developed feature: added functionality to specify unit types for the Spacing property in the Row element, improving Fluent API consistency (by @sclarke81)
- Back-ported community-developed improvement: integrated CancellationToken support in the ShowInPreviewer method (by @marcmognol)
- Back-ported community-developed improvement: simplified DynamicComponent usage by introducing a state-less component model (by @bennetbo)

Version 2022.12.12
- Fixed: table layout renders incorrectly if one of its cells spans at least three pages

Version 2022.12.13
- Fixed: The hyperlink element was annotating the incorrect location, in specific layout scenarios when used with right-to-left content direction
- Maintenance: The QuestPDF Previewer application has been updated to utilize the latest version of the Avalonia library

Version 2022.12.14
- Improvement: enhanced the automated layout issue detection algorithm to cover a broader range of cases.
- Update: upgraded the SkiaSharp dependency to version 2.88.7. This update addresses issues with JPEG images being incorrectly encoded/decoded on ARM devices.
- Maintenance: added .NET 8 as an official build target for the library.