QuestPDF 2024.3.7

dotnet add package QuestPDF --version 2024.3.7
NuGet\Install-Package QuestPDF -Version 2024.3.7
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.3.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add QuestPDF --version 2024.3.7
#r "nuget: QuestPDF, 2024.3.7"
#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.3.7

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

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 (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 (9)

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.7 922 5/20/2024
2024.3.6 4,481 5/14/2024
2024.3.5 4,734 5/12/2024
2024.3.4 7,431 5/6/2024
2024.3.3 3,458 5/2/2024
2024.3.2 10,951 4/25/2024
2024.3.1 10,257 4/22/2024
2024.3.0 18,742 4/12/2024
2024.3.0-rc2 2,377 3/30/2024
2024.3.0-rc1 195 3/29/2024
2024.3.0-rc 549 3/27/2024
2024.3.0-beta1 1,112 3/18/2024
2024.3.0-beta 2,328 2/29/2024
2024.3.0-alpha 1,336 2/15/2024
2023.12.6 133,818 2/21/2024
2023.12.5 42,246 2/7/2024
2023.12.4 75,254 1/15/2024
2023.12.3 9,522 1/12/2024
2023.12.2 33,313 1/1/2024
2023.12.1 40,582 12/15/2023
2023.12.0 37,286 12/3/2023
2023.10.2 61,761 11/13/2023
2023.10.1 31,314 10/31/2023
2023.10.0 27,224 10/23/2023
2023.10.0-alpha0 334 10/13/2023
2023.9.1 33,650 10/6/2023
2023.9.0 28,417 9/25/2023
2023.6.3 92,434 8/27/2023
2023.6.2 492 8/26/2023
2023.6.1 77,322 7/20/2023
2023.6.0 48,573 6/28/2023
2023.5.3 59,912 6/12/2023
2023.5.2 49,094 5/31/2023
2023.5.1 22,608 5/22/2023
2023.5.0 11,773 5/15/2023
2023.4.2 12,198 5/9/2023
2023.4.1 3,744 5/4/2023
2023.4.0 615 5/4/2023
2022.12.15 38,280 2/7/2024
2022.12.14 14,066 1/12/2024
2022.12.13 5,673 1/1/2024
2022.12.12 12,694 12/15/2023
2022.12.11 9,832 12/3/2023
2022.12.10 7,178 11/13/2023
2022.12.9 2,285 10/31/2023
2022.12.8 6,338 10/23/2023
2022.12.7 62,871 10/6/2023
2022.12.6 359,934 5/9/2023
2022.12.5 130,474 4/27/2023
2022.12.4 24,725 4/22/2023
2022.12.3 69,613 4/16/2023
2022.12.2 249,921 3/12/2023
2022.12.1 486,152 1/13/2023
2022.12.0 135,998 12/14/2022
2022.11.0 340,323 11/5/2022
2022.11.0-alpha1 310 11/1/2022
2022.11.0-alpha0 278 10/28/2022
2022.9.1 80,240 10/15/2022
2022.9.0 123,722 9/18/2022
2022.9.0-alpha1 266 9/16/2022
2022.8.2 149,718 8/21/2022
2022.8.1 20,710 8/19/2022
2022.8.0 79,377 8/15/2022
2022.6.3 48,764 7/18/2022
2022.6.2 119,219 6/22/2022
2022.6.1 21,809 6/12/2022
2022.6.0 141,294 6/12/2022
2022.6.0-prerelease 1,717 5/30/2022
2022.5.0 261,676 5/9/2022
2022.4.1 90,136 4/8/2022
2022.4.0 61,269 4/4/2022
2022.4.0-alpha1 307 3/27/2022
2022.4.0-alpha0 271 3/27/2022
2022.3.1 95,334 3/15/2022
2022.3.0 2,375 3/14/2022
2022.2.7 1,718 3/12/2022
2022.2.6 6,434 3/8/2022
2022.2.5 19,311 2/18/2022
2022.2.4 663 2/18/2022
2022.2.3 10,383 2/7/2022
2022.2.2 1,990 2/1/2022
2022.2.1 1,557 1/30/2022
2022.2.0 1,754 1/29/2022
2022.2.0-beta1 297 1/24/2022
2022.1.0 21,938 1/10/2022
2022.1.0-beta5 945 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 30,448 12/6/2021
2021.12.0-alpha1 1,128 11/29/2021
2021.12.0-alpha0 352 11/18/2021
2021.11.4 21,680 11/14/2021
2021.11.3 4,758 11/7/2021
2021.11.0-beta3 360 11/3/2021
2021.11.0-beta2 375 10/28/2021
2021.11.0-beta 427 10/23/2021
2021.10.1 9,824 9/30/2021
2021.10.0 572 9/30/2021
2021.10.0-beta.2 249 9/14/2021
2021.10.0-beta 375 9/13/2021
2021.9.3 5,155 9/12/2021
2021.9.2 670 9/1/2021
2021.9.1 515 9/1/2021
2021.9.0 486 8/30/2021
2021.8.0 2,446 8/2/2021
2021.5.2 2,798 5/5/2021
2021.4.0 725 4/2/2021
2021.3.1 7,076 3/1/2021
2021.3.0 538 3/1/2021
2021.2.0 592 2/8/2021
2021.1.0 649 1/4/2021
2020.11.0 9,511 11/1/2020

Version 2024.3.0

The primary theme of this release is the removal of the SkiaSharp dependency and the introduction of a custom native layer built on top of Skia M124.


This change was necessary to provide much higher flexibility and enable several new long-awaited features:
- Font subsetting - this feature includes only necessary font glyphs in the output document, greatly reducing the file size, especially when using glyph-rich fonts supporting multiple languages,
- Improved text-related capabilities, including but not limited to text justification, bi-directionality, enhanced line breaking algorithms, more styles for text decoration, word spacing, and more,
- Introduced additional document compression to further reduce file size,
- Integrated native SVG support,
- In future releases: enhanced accessibility through support for PDF tags.


Other changes:
- Removed the SkiaSharp dependency, thereby making QuestPDF a standalone library,
- Updated the Lato font to the latest version (2.015),
- Included licenses of the third-party dependencies in the NuGet package,
- Included a list of Contributors in the NuGet package to acknowledge the valuable input from our Community in improving QuestPDF.


Unfortunately, this release also introduces breaking changes:
- Removed support for injecting SkiaSharp content directly into the document. It is still possible to integrate SkiaSharp through vector and raster graphics; please consult the documentation for more details,
- Removed support for platforms: Android, iOS, UWP, WASM, and Linux-Alpine. We are currently investigating reintroducing support for WASM and Linux-Alpine in future releases.

We would like to thank the SkiaSharp project, its maintainers, and contributors, for creating a fantastic graphics library. It was a fantastic foundation for QuestPDF for over 3 years.


Version 2024.3.1
- Enhanced discoverability of text alignment options (AlignLeft, AlignCenter, AlignRight, AlignStart, AlignEnd and Justify) when using the shorthand Text method (common use case).
- To enhance compatibility with existing codebases, we've removed the breaking change associated with the deprecation of the TextStyle.Fallback method. Although this method remains obsolete, we've reintroduced it with a compatibility layer to prevent disruptions.
- Enhanced compatibility with dotnet standard projects.
- Fix: on the Windows platform, the "Could not find an appropriate font fallback for the following glyphs: $U-000D" exception is thrown when the "QuestPDF.Settings.CheckIfAllTextGlyphsAreAvailable" is set true, and the "TextDescriptor.Line" method is used (that inserts the '\r' character).
- Fix: resolved an issue where the positioning of hyperlinks was incorrect when text contained injected block items.


Version 2024.3.2
- Introduced support for the linux-musl-x64 platform.
- Adjusted how the Lato font is embedded in the NuGet package to prevent issues with the files not being provided on the platform-specific runtimes.
- Improved compatibility with texts that contain the carriage return character '\r'.
- Enhanced exception messages when the FontManager.RegisterFont method fails due to an invalid font file.
- Enhanced the Canvas element deprecation message by adding a link to the documentation.
- Fixed: the SVG image is not always scaled properly, especially when uses relative units internally (percentage, cm, "mm", etc.).
- Fixed a sporadic `AccessViolationException` that occurred when UseEnvironmentFonts was set to `false` and documents were generated in parallel.
- Fixed an issue where dynamic SVG images were not utilizing the available space correctly. This resulted in images with a zero size.


Version 2024.3.3
- Improved the default scaling behavior of Image and SvgImage elements when they are direct descendants of the Constrained element (Width, Height, MinWidth, MinHeight, MaxWidth, MaxHeight).
- Enhanced handling of texts containing the carriage return character '\r' within the custom page format setting.
- Fixed: enhanced the handling of the TextStyle.LineHeight modifier for better consistency with industry-standard software, as well as adjusted the default value.
- Fixed: when the UseEnvironmentFonts setting is enabled, the Lato font was not being properly registered. This issue could lead to runtime exceptions in specific minimal environments.
- Fixed: Addressed a potential null reference exception in the SvgImage object’s finalizer that could lead to application crashes when handling invalid SVG content.


Version 2024.3.4
- Improved font rendering by setting half-leading when line-height is overridden.
- Enhanced exception messages for unsupported x86 platforms.


Version 2024.3.5
- Enhancement: text uses half-leading by default.
- Fixed: default text decoration color should match font color.
- Fixed: the Column element may not render successfully when it has non-zero spacing, contains a child with zero height, and is repeated.


Version 2024.3.6
- Introduced support for the win-x86 platform.
- Improved SVG image support for less common unit types.
- Enhanced automated testing environment.

Version 2024.3.7
- Introduced an explicit CallingConvention.Cdecl to address and fix the issue of stack imbalance on Windows platforms.