Configuration

Configure document metadata, generation settings, content direction, compression, PDF/A and PDF/UA conformance, and global library settings.

Document Metadata

Every PDF carries metadata fields visible in the document properties dialog (Acrobat: File → Properties). Set them via WithMetadata() on the document:

using FolioPDF;
using FolioPDF.Fluent;
using FolioPDF.Helpers;
using FolioPDF.Infrastructure;

Document.Create(doc =>
{
    doc.Page(page =>
    {
        page.Size(PageSizes.A4);
        page.Margin(50);
        page.Content().Text("Configured document").FontSize(16);
    });
})
.WithMetadata(new DocumentMetadata
{
    Title = "Q1 Financial Report",
    Author = "Finance Team",
    Subject = "Quarterly revenue and expense summary",
    Keywords = "finance, Q1, 2026, revenue",
    Creator = "Acme Reporting System",
    Producer = "FolioPDF",
    Language = "en-US",
    CreationDate = new DateTimeOffset(2026, 4, 1, 0, 0, 0, TimeSpan.Zero),
    ModifiedDate = DateTimeOffset.Now
})
.GeneratePdf("configured.pdf");

DocumentMetadata Properties

Document Settings

Control the generation process — compliance levels, compression, image quality, form fields, and automatic structure tagging:

Document.Create(doc =>
{
    doc.Page(page =>
    {
        page.Size(PageSizes.A4);
        page.Margin(50);
        page.Content().Text("High-quality archival document").FontSize(16);
    });
})
.WithSettings(new DocumentSettings
{
    PdfAConformance = PdfAConformance.PdfA_2B,
    PdfUaConformance = PdfUaConformance.PdfUA_1,
    ContentDirection = ContentDirection.LeftToRight,
    CompressDocument = true,
    ImageCompressionQuality = ImageCompressionQuality.High,
    ImageRasterDpi = 288,
    AutoTagDocument = true,
    EnableForms = false
})
.WithMetadata(new DocumentMetadata
{
    Title = "Archival Document",
    Language = "en-US"
})
.GeneratePdf("archival.pdf");

DocumentSettings Properties

Enums Reference

PdfAConformance

PdfUaConformance

ContentDirection

// Arabic document
Document.Create(doc =>
{
    doc.Page(page =>
    {
        page.Size(PageSizes.A4);
        page.Margin(50);
        page.ContentFromRightToLeft();
        page.Content().Text("\u0645\u0631\u062D\u0628\u0627 \u0628\u0627\u0644\u0639\u0627\u0644\u0645").FontSize(24);
    });
})
.WithSettings(new DocumentSettings
{
    ContentDirection = ContentDirection.RightToLeft
})
.WithMetadata(new DocumentMetadata { Language = "ar" })
.GeneratePdf("arabic.pdf");

ImageCompressionQuality

Global Settings

The Settings static class controls library-wide behaviour. These settings are applied before any document is generated.

using FolioPDF;

// Add a custom font directory
Settings.FontDiscoveryPaths.Add("/usr/share/fonts/custom");
Settings.FontDiscoveryPaths.Add("C:\\Fonts\\Corporate");

// Disable system fonts (use only explicitly registered fonts)
Settings.UseEnvironmentFonts = false;

// Enable caching for better performance (default: true)
Settings.EnableCaching = true;

// Enable debugging for detailed layout error messages
Settings.EnableDebugging = true;

// Throw on missing glyphs instead of rendering placeholders
Settings.CheckIfAllTextGlyphsAreAvailable = true;

Settings Properties

Default Values Summary

A quick reference of all default values when no explicit configuration is provided:

Combining Metadata and Settings

WithMetadata() and WithSettings() can be chained in any order. Both return the Document instance for fluent chaining:

Document.Create(doc =>
{
    doc.Page(page =>
    {
        page.Size(PageSizes.A4);
        page.Margin(50);
        page.Content().Text("Fully configured").FontSize(16);
    });
})
.WithMetadata(new DocumentMetadata
{
    Title = "Annual Report",
    Author = "Legal Dept",
    Language = "en-US"
})
.WithSettings(new DocumentSettings
{
    PdfAConformance = PdfAConformance.PdfA_2A,
    PdfUaConformance = PdfUaConformance.PdfUA_1,
    ImageCompressionQuality = ImageCompressionQuality.Best,
    ImageRasterDpi = 300
})
.GeneratePdf("annual-report.pdf");