Back to Questpdf

Description

Source/QuestPDF/Resources/Description.md

2026.6.112.7 KB
Original Source

QuestPDF - Modern PDF library for C# developers

QuestPDF is a production-ready library that lets you design documents the way you design software: with clean, maintainable, strong-typed C# code. Stop fighting with HTML-to-PDF conversion. Build pixel-perfect reports, invoices, and exports using the language and tools you already love.

The library is free for individuals, non-profits, all FOSS projects, and organizations under $1M in annual revenue. Read more


Home Page

Quick Start

Real-world Invoice Tutorial

Features Overview

Pricing

License

NuGet


πŸš€ Quick start

Learn how easy it is to design, implement and generate PDF documents using QuestPDF. Effortlessly create documents of all types such as invoices and reports.

c#
using QuestPDF.Fluent;
using QuestPDF.Helpers;
using QuestPDF.Infrastructure;

// set your license here:
// QuestPDF.Settings.License = LicenseType.Community;

Document.Create(container =>
{
    container.Page(page =>
    {
        page.Size(PageSizes.A4);
        page.Margin(2, Unit.Centimetre);
        page.PageColor(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");

The code above produces the following PDF document:

Everything you need to generate PDFs

QuestPDF provides 60+ production-ready features for building complex, data-driven PDF documents with clean and maintainable C# code.

🧱 Layout:

Page setup, headers, footers, watermarks, tables, rows, columns, lists, layers, inlined content, multi-column flow, sections, decorations

🎨 Visual Content:

Rich text, fonts, colors, backgrounds, borders, rounded corners, shadows, lines, raster images, SVG, placeholders, canvas graphics

πŸ“ Positioning:

Alignment, width, height, padding, aspect ratio, rotation, scaling, scale-to-fit, offset, flip, extend, shrink, unconstrained layout, Z-index

🌊 Content Flow:

Page breaks, prevent page breaks, ensure space, show entire, repeat, show once, skip once, conditional rendering, stop paging

🧩 Dynamic Documents:

Loops, conditions, reusable components, dynamic components, lazy loading, custom helpers, extension methods, strongly-typed models

🌍 Internationalization:

RTL layout direction, bidirectional text, advanced text shaping, font fallback, multilingual documents, accessibility support

Familiar Programming Patterns

Use your existing programming language and patterns to ship faster with less training.

Loops, conditionals, functions are natively supported. Leverage IntelliSense, inspections, navigation, and safe refactoring.

csharp
container.Column(column =>
{
    column.Item().Text("Order Items").Bold();

    if (Model.ShowSummary)
        column.Item().Element(ComposeOrderSummary);

    foreach (var item in Model.Items)
        column.Item().Element(c => ComposeItem(c, item));
});

Review document changes like any other code. Get clean diffs, PR approvals, and traceable history.

diff
void ComposeItem(IContainer container, OrderItem item)
{
    container
        .Border(1, Colors.Grey.Darken2)
        .Background(item.HighlightColor)
-       .Padding(12)
+       .Padding(16)
        .Row(row =>
        {
            row.RelativeItem().Text(item.Name);
            row.AutoItem().Text($"{item.Price:F2} USD");
        });
}

Companion App

Accelerate development with live document preview and hot-reload capability. See your changes instantly without recompiling.

  • 🧭 Explore PDF document hierarchy and navigate its structure
  • πŸ” Quickly magnify and measure content
  • 🐞 Debug runtime exceptions with stack traces and code snippets
  • πŸ› οΈ Identify, understand and solve layout errors

Enterprise-grade foundations

🧩 Dynamic Content Is Just Code

Use your existing programming language and development patterns to ship faster with less training. Loops, conditionals, functions, reusable components, and data-driven generation are supported natively.

πŸ”€ Version Control Friendly

Review document changes like any other code. Get clean diffs, pull request approvals, traceable history, and safer collaboration across your team.

✨ Ready for AI

QuestPDF’s semantic Fluent API helps AI assistants generate layouts, refactor components, explain document structure, and troubleshoot issues more effectively.

🎯 Predictable Development

Eliminate CSS debugging, browser quirks, and layout surprises common with HTML-to-PDF tools. What you code is what you get.

πŸ‘οΈ Source-available

Entire QuestPDF source code is available for review and customization, ensuring transparency and compliance with your organization's requirements.

πŸ”’ Complete Data Privacy

QuestPDF runs entirely within your infrastructure with no external API calls, internet requirement, or background data collection. As a company, we do not access, collect, store, or process your private data.

πŸ—οΈ Comprehensive Layout Engine

A powerful layout engine built specifically for PDF generation. Gain full control over document structure, precise content positioning, and automatic pagination.

🌐 Advanced Language Support

Create multilingual documents with full RTL language support, advanced text shaping, and bi-directional layout handling.

⚑ High Performance

Generate thousands of pages per second while maintaining minimal CPU and memory usage. Perfect for high-throughput enterprise applications.

πŸ“¦ Optimized File Size

Drastically reduce file sizes without compromising quality. Benefit from automatic font subsetting, optimal image compression, and efficient file compression.

Perform common PDF operations

Leverage a powerful C# Fluent API to create, customize, and manage your PDF documents with ease.

  • πŸ”— Merge documents
  • πŸ“Ž Attach files
  • βœ‚οΈ Extract pages
  • πŸ” Encrypt / decrypt
  • 🏷️ Extend metadata
  • 🚫 Limit access
  • ⚑ Optimize for Web
  • πŸ“‘ Overlay / underlay
c#
DocumentOperation
    .LoadFile("input.pdf")
    .TakePages("1-10")
    .MergeFile("appendix.pdf", "1-z") // all pages
    .AddAttachment(new DocumentAttachment
    {
        FilePath = "metadata.xml"
    })
    .Encrypt(new Encryption256Bit
    {
        OwnerPassword = "mypassword",
        AllowPrinting = true,
        AllowContentExtraction = false
    })
    .Save("final-document.pdf");

Works everywhere you do

Deploy on any major operating system and integrate seamlessly with your favorite IDEs, cloud platforms, and development tools.

PlatformSupport
Operating SystemsWindows, Linux, macOS
Frameworks.NET 6+ and .NET Framework 4.6.2+
CloudAzure, AWS, Google Cloud, Others
ContainersDocker, Kubernetes
IDEsVisual Studio, VS Code, JetBrains Rider, Others

Industry-standard PDF compliance

Generate PDF documents that meet the strictest archival and accessibility requirements. Every build is automatically validated using the open-source veraPDF and Mustang tools.

πŸ—„οΈ PDF/A (Archival)

  • Purpose: ISO 19005 standard for long-term preservation. Ensures PDFs remain readable and visually identical for decades without external dependencies.
  • Supported Standards: PDF/A-2b, PDF/A-2u, PDF/A-2a, PDF/A-3b, PDF/A-3u, PDF/A-3a

β™Ώ PDF/UA (Accessibility)

  • Purpose: ISO 14289 standard for universal accessibility. Includes full support for screen readers and assistive technologies for people with disabilities.
  • Supported Standards: PDF/UA-1

🧾 EN 16931 (E-Invoicing):

  • Purpose: European standard for electronic invoicing. Embeds structured invoice data (XML) within PDF documents for automated processing.
  • Supported Standards: ZUGFeRD, Factur-X

Fair and Sustainable License

A model that benefits everyone. Commercial licensing provides businesses with legal safety and long-term stability, while funding a feature-complete, unrestricted library for the open-source community.

  • Actively maintained with regular feature, quality, and security updates
  • Full source code available on GitHub
  • All features included in every tier without restrictions
  • Predictable pricing: no per-seat, per-server, or usage fees

The library is free for individuals, non-profits, all FOSS projects, and organizations under $1M in annual revenue.

See a real-world example

Follow our detailed tutorial and see how easy it is to generate a fully functional invoice with fewer than 250 lines of C# code.

  • Step-by-step guidance
  • Production-ready code
  • Best practices included

Community QuestPDF

We are incredibly grateful to our .NET Community for their positive reviews and recommendations of the QuestPDF library. Your support and feedback are invaluable and motivate us to keep improving and expanding this project. Thank you for helping us grow and reach more developers!

Nick Chapsas: The Easiest Way to Create PDFs in .NET

JetBrains: OSS Power-Ups: QuestPDF