PdfDocument

namespace ObviousPDF — The main entry point for creating PDF files.

var doc = new PdfDocument();
doc.Info.Title = "My Document";
doc.Language = "en-US";
doc.Save("output.pdf");

Properties

Methods

PdfPageRange

namespace ObviousPDF — A readonly struct representing a contiguous range of zero-based page indices. Used with PdfDocument.Split.

// Pages 0-2 into doc1, pages 3-4 into doc2
var parts = doc.Split(new[] {
    new PdfPageRange(0, 3),
    PdfPageRange.FromStartEnd(3, 4)
});

Properties

Constructor & Factory

PdfPageBuilder

namespace ObviousPDF — Fluent API for adding content to a single PDF page.

Text Methods

Vector Graphics Methods

Image Methods

Transform & State Methods

Clipping Methods

Annotation Methods

Form Field Methods

Tagged Content (Accessibility) Methods

Pattern, Shading & Layer Methods

PdfTextOptions

namespace ObviousPDF — Configuration for text rendering.

PdfTextAlignment Enum

ISO 32000-2 §14.8.5.4 (TextAlign attribute). For Justify, word spacing (Tw operator §9.3.3) is adjusted so the line fills the width. In AddTextBlock, the last line is left-aligned.

Text Rotation

// 45-degree diagonal text
page.AddText("Diagonal", 200, 400, new PdfTextOptions { Rotation = 45 });

// Vertical text — reads bottom to top
page.AddText("Vertical", 400, 300, new PdfTextOptions { Rotation = 90, FontSize = 14 });

// White text on a black background
page.AddText("White on Black", 72, 350, new PdfTextOptions
{
    Color = PdfColor.FromRgb(1, 1, 1),
    BackgroundColor = PdfColor.Black,
    FontSize = 16
});

// Rotation with background — the background rectangle rotates with the text
page.AddText("Rotated highlight", 200, 500, new PdfTextOptions
{
    Rotation = 30,
    BackgroundColor = PdfColor.FromRgb(1.0, 1.0, 0.0),
    FontSize = 14
});

Implemented via PDF CTM (cm operator, ISO 32000 §8.3.4) wrapped in a q/Q graphics-state pair. Background rectangles, drop shadows, and decoration lines all rotate with the text. To rotate shapes or images, use SaveGraphicsState() / Rotate() / RestoreGraphicsState() instead.

PdfDrawOptions

namespace ObviousPDF — Configuration for vector graphics rendering.

PdfColor

namespace ObviousPDF — Represents a colour in DeviceGray, DeviceRGB, or DeviceCMYK.

// RGB (each 0.0–1.0)
var red = new PdfColor(1.0, 0.0, 0.0);

// Named factory methods
var gray = PdfColor.FromGray(0.5);
var blue = PdfColor.FromRgb(0.0, 0.2, 0.8);
var cyan = PdfColor.FromCmyk(1.0, 0.0, 0.0, 0.0);

Factory Methods

Properties

PdfImage

namespace ObviousPDF — Loads and represents JPEG and PNG images for embedding.

PdfEmbeddedFont

namespace ObviousPDF — Loads TrueType/OpenType fonts for embedding with automatic subsetting.

StandardFont

namespace ObviousPDF.Fonts — The 14 standard PDF fonts. ObviousPDF auto-embeds SIL OFL substitutes.

PageSize

namespace ObviousPDF — Predefined page size tuples (width × height in points).

PdfDocumentInfo

namespace ObviousPDF — Document metadata.

PdfFormXObject

namespace ObviousPDF — Reusable content stream for headers, footers, watermarks.

var header = doc.CreateFormXObject(612, 35);
header.FillRectangle(0, 0, 612, 35, opts);
header.AddText("Header Text", 72, 10, textOpts);

// Place on every page
page.AddFormXObject(header, 0, 757);

PdfPathBuilder

namespace ObviousPDF — Low-level path construction via BeginPath().

page.BeginPath(new PdfDrawOptions { FillColor = blue })
    .MoveTo(300, 440)
    .CurveTo(350, 520, 440, 480, 420, 440)
    .ClosePath()
    .FillAndStroke();

PdfStructureElement

namespace ObviousPDF.Accessibility — A node in the PDF structure tree (ISO 32000 §14.7.2).

Properties

Methods

StructureType (40+ types)

namespace ObviousPDF.Accessibility — All ISO 32000 structure types.

PdfAccessibilityChecker

namespace ObviousPDF.Accessibility — Validates 43+ PDF/UA, WCAG 2.2, and ISO 32000 requirements.

var checker = new PdfAccessibilityChecker();
var report = checker.Check(doc);

Console.WriteLine(report.IsFullyCompliant);  // true/false
Console.WriteLine(report.ToString());        // Human-readable report

foreach (var issue in report.NonCompliantItems)
    Console.WriteLine($"  ❌ {issue}");

Automatic Report Generation (v1.3.0)

Enable accessibility report generation on every Save() or Sign() call:

doc.GenerateAccessibilityReport = true;
doc.Save("output.pdf");

if (doc.LastAccessibilityReport != null)
    Console.WriteLine(doc.LastAccessibilityReport.ToString());

{
  "accessible": true,
  "generateAccessibilityReport": true,
  "pages": [ ... ]
}

PdfAccessibilityReport

PdfArtifactType

PdfTableScope

PdfPhoneticAlphabet

PdfColorContrast

Static utility for WCAG contrast checking.

Annotations

namespace ObviousPDF

PdfAnnotationType

PdfStampIcon

PdfAcroField

namespace ObviousPDF — Interactive form field configuration.

var formElement = root.AddChild(StructureType.Form);
var field = new PdfAcroField(PdfAcroFieldType.Text,
    "fullName", 72, 675, 250, 20)
{
    Tooltip = "Full name (required)",
    Required = true
};
page.AddTaggedAcroField(formElement, field);

PdfAcroFieldType

PdfEncryption

namespace ObviousPDF — Password and permission settings.

PdfDigitalSignature

namespace ObviousPDF — PKCS#7/CMS digital signature configuration. Requires an X509Certificate2 with an exportable private key (.pfx/.p12). See the Certificate Setup Guide for instructions on creating a self-signed certificate or obtaining one from a trusted CA.

Visual Effects

PdfShadingPattern

namespace ObviousPDF — Axial (linear) and radial gradient definitions.

// Linear gradient
var linear = new PdfShadingPattern(
    72, 650, 300, 650,
    PdfColor.FromRgb(0.1, 0.3, 0.8),
    PdfColor.FromRgb(0.4, 0.9, 0.6));
page.FillWithShading(linear, 72, 620, 228, 60);

// Radial gradient
var radial = PdfShadingPattern.RadialGradient(
    440, 650, 0, 70,
    PdfColor.FromRgb(1, 0.9, 0.2),
    PdfColor.FromRgb(0.9, 0.2, 0.1));
page.FillWithShading(radial, 370, 580, 140, 140);

PdfTilingPattern

namespace ObviousPDF — Repeating tile patterns for fills.

var stripe = new PdfTilingPattern(10, 10);
stripe.FillRectangle(0, 0, 10, 10, lightColor);
stripe.FillRectangle(0, 0, 5, 10, darkColor);
page.FillWithPattern(stripe, 72, 480, 228, 80);

Document Features

PdfOutlineItem

Bookmarks for sidebar navigation.

PdfPageLabelStyle

PdfOptionalContentGroup

Toggle-able layers (OCG). Created via doc.CreateOptionalContentGroup(name, visible).

Conformance Levels

PdfAConformanceLevel (Archival)

PdfUaConformanceLevel (Accessibility)

Coordinate System

JSON Renderer — ObviousPDF.Json

namespace ObviousPDF.Json — JSON-to-PDF pipeline. Accepts a JSON document conforming to the ObviousPDF JSON schema and produces a tagged, accessible PDF binary.

using ObviousPDF.Json;

// Render JSON string → PDF bytes
byte[] pdf = PdfJsonRenderer.Render(jsonString);

// Render from a .json file path → PDF bytes
byte[] pdf = PdfJsonRenderer.RenderFromFile("document.json");

// Build PdfDocument for further manipulation
PdfDocument doc = PdfJsonRenderer.BuildDocument(jsonString);
doc.Save("output.pdf");

PdfJsonRenderer — Static Methods

JSON Document Root Object

The JSON document root is an object with 15 top-level keys. Only pages is required.

document Settings Object

Page Object

Content Element Types

Every element is identified by a required "type" string. All elements additionally accept structureId, artifact, artifactType, and artifactSubtype for accessibility and artifact marking.

Text Options Object

Draw Options Object

Color Format

Any property accepting a color can be: a named string ("black", "white", "red", "green", "blue"), an RGB object {"r":0–1,"g":0–1,"b":0–1}, a gray object {"gray":0–1}, or a CMYK object {"c":0–1,"m":0–1,"y":0–1,"k":0–1}.

Additional Resources

📄 Download JSON Schema (draft-07) 🤖 LLM Guide — JSON Renderer 🗂️ Form 1040 Example ⚡ Easy Accessibility

XML Renderer — ObviousPDF.Xml

namespace ObviousPDF.Xml — XML-to-PDF pipeline. Accepts an XML document conforming to the ObviousPDF XML Schema and produces a tagged, accessible PDF. Internally deserializes to the shared model and delegates to the JSON renderer pipeline.

using ObviousPDF.Xml;

// Render XML string → PDF file
PdfXmlRenderer.Render(xmlString, "output.pdf");

// Render from an XML file
PdfXmlRenderer.RenderFromFile("input.xml", "output.pdf");

// Build PdfDocument for further manipulation
PdfDocument doc = PdfXmlRenderer.BuildDocument(xmlString);
doc.Save("output.pdf");

PdfXmlRenderer — Static Methods

PdfXmlRenderer — Instance Methods

Create an instance with PdfXmlRendererOptions for configurable rendering.

PdfXmlRendererOptions

PdfXmlRenderResult

PdfXmlValidator

Validate an XML document without rendering it.

PdfXmlValidationResult

PdfXmlRenderException

Thrown when XML-to-PDF rendering fails. Inherits from Exception.

XML Namespace

All elements belong to https://obviouspdf.com/schemas/xml/1.0. The XML schema mirrors the JSON schema — the same document model, content elements, and structure tree are supported via XML element/attribute syntax.

<Document xmlns="https://obviouspdf.com/schemas/xml/1.0">
  <Pages>
    <Page size="Letter">
      <Content>
        <Text x="72" y="720">Hello, ObviousPDF!</Text>
      </Content>
    </Page>
  </Pages>
</Document>

CSV Renderer — ObviousPDF.Csv

namespace ObviousPDF.Csv — Convert section-based CSV documents to tagged, accessible PDFs. The CSV pipeline internally delegates to the JSON renderer, ensuring identical behavior across all three input formats.

PdfCsvRenderer — Static Methods

PdfCsvRenderer — Instance Methods

Create an instance with PdfCsvRendererOptions for configurable rendering.

PdfCsvRendererOptions

PdfCsvRenderResult

PdfCsvValidator

Validate a CSV document without rendering it.

PdfCsvValidationResult

PdfCsvRenderException

Thrown when CSV-to-PDF rendering fails. Inherits from Exception.

CSV Format

The CSV format uses section headers in square brackets ([DOCUMENT], [FONTS], [PAGE 1], etc.) with column-header rows per section. RFC 4180 compliant, auto-detects comma or tab delimiters. Pipe (|) is used for multi-value fields. Base64 data supports continuation rows with + prefix.

[PAGE 1]
type,x,y,text
text,72,720,Hello ObviousPDF!