Aspose.PDF for .NET — Agentic Examples

Agentic, build-validated C# code examples for Aspose.PDF for .NET covering PDF creation, conversion, editing, annotations, forms, digital signatures, and text extraction. Every example compiles and runs successfully. Includes AGENTS.md guides optimized for AI coding agents.

Overview

This repository provides working code examples demonstrating Aspose.PDF for .NET capabilities. All examples are automatically generated, compiled, and validated using the Aspose.PDF Examples Generator.

For AI Coding Agents

This repository is structured for direct use by AI coding agents and LLM-powered tools:

• AGENTS.md — root-level guide covering API surface, anti-patterns, and category tips
• Per-category AGENTS.md — targeted guidance inside each category folder
• index.json — machine-readable manifest of all 2636 examples with metadata
• MCP-compatible — integrate with any MCP client (Claude Desktop, Cursor, Continue.dev)

Categories

Each category contains standalone .cs files that can be compiled and run independently.

Frequently Asked Questions

How do I create a new PDF from scratch in Aspose.PDF for .NET?

Instantiate Aspose.Pdf.Document, add pages via doc.Pages.Add(), then doc.Save("output.pdf"). See the basic-operations and document category folders for working examples.

How do I convert a PDF to DOCX, HTML, or an image in Aspose.PDF for .NET?

Load the source with new Document(path), then doc.Save(target, SaveFormat.DocX) (or Html / Xps / Tiff / etc.). Per-format examples live in the conversion and facades-convert-documents folders.

How do I extract text from a PDF in Aspose.PDF for .NET?

Use TextAbsorber (page-level) or TextFragmentAbsorber (search-based). Examples of both patterns live in working-with-text and facades-extract-images-and-text.

How do I add form fields (text boxes, checkboxes, radio buttons) to a PDF?

Use TextBoxField, CheckboxField (lowercase 'b'!), RadioButtonField, ButtonField -- all in the Aspose.Pdf.Forms namespace. Attach with doc.Form.Add(field, pageNum). See working-with-forms and facades-forms for complete examples.

How do I digitally sign a PDF in Aspose.PDF for .NET?

Use PdfFileSignature (facades) or SignatureField + PkcsSignature (core API). Load a PFX certificate with new PdfFileSignature(document), then Sign(...). See securing-and-signing-pdf and facades-sign-documents for working end-to-end examples.

How do I encrypt or decrypt a PDF in Aspose.PDF for .NET?

Call doc.Encrypt(userPass, ownerPass, DocumentPrivilege.ForbidAll, CryptoAlgorithm.AESx256, false) before Save, or new Document(path, password) to open an encrypted PDF. Examples in securing-and-signing-pdf and facades-secure-documents.

How do I add bookmarks or an outline / TOC to a PDF?

Create OutlineItemCollection (the type doubles as both node and child container -- there is no separate OutlineItem singular type in Aspose.PDF), set Title / Action / Open, then doc.Outlines.Add(item) or parent.Add(child). Examples in facades-bookmarks.

How do I add annotations (highlights, comments, stamps) to a PDF?

Annotation types live in Aspose.Pdf.Annotations (HighlightAnnotation, TextAnnotation, StampAnnotation, LinkAnnotation, SquareAnnotation, etc.). Attach via page.Annotations.Add(annotation). See working-with-annotations and facades-annotations.

How do I merge or split PDFs in Aspose.PDF for .NET?

Merge with PdfFileEditor.Concatenate(...). Split by page range with PdfFileEditor.SplitFromFirst / SplitToEnd / SplitFromFile. See facades-edit-document for both patterns.

How do I convert a PDF to PDF/A for archival compliance?

Load the document, then doc.Convert(logStream, PdfFormat.PDF_A_1B, ConvertErrorAction.Delete) (or PDF_A_2B / PDF_A_3B). Save and the resulting file is PDF/A-compliant. See conversion for full samples.

Can these examples be used by AI coding agents like Claude, Copilot, or Cursor?

Yes -- the repository ships an AGENTS.md at root and one per category, plus .well-known/agent.json, llm.txt, mcp.json, and a machine-readable index.json. Point your agent at the repo's raw URLs (or install the MCP server) and it can browse examples programmatically.

Do I need an Aspose.PDF license to run these examples?

The library runs in evaluation mode without a license (with page-count and collection-size limits). For production use, apply a license via new License().SetLicense(path). Purchase / trial options: https://purchase.aspose.com/buy.

Getting Started

Prerequisites

• .NET SDK (net10.0 or compatible version)
• Aspose.PDF for .NET NuGet package (26.7.0)
• Valid Aspose license (for production use)

Running Examples

Each example is a self-contained C# file. To run an example:

cd <CategoryFolder>
dotnet new console -o ExampleProject
cd ExampleProject
dotnet add package Aspose.PDF --version 26.7.0
# Copy the example .cs file as Program.cs
dotnet run

Code Patterns

Loading a PDF

using (Document pdfDoc = new Document("input.pdf"))
{
    // Work with document
}

Error Handling

if (!File.Exists(inputPath))
{
    Console.Error.WriteLine($"Error: File not found - {inputPath}");
    return;
}

try
{
    // Operations
}
catch (Exception ex)
{
    Console.Error.WriteLine($"Error: {ex.Message}");
}

Important Notes

• One-based indexing: Aspose.PDF uses 1-based page indexing (Pages[1] = first page)
• Deterministic cleanup: All IDisposable objects wrapped in using blocks
• Console output: Success/error messages written to Console.WriteLine/Console.Error
• Fully qualified types: Use Aspose.Pdf.Drawing.Path (not bare Path) to avoid ambiguity with System.IO.Path

Agentic .NET Ecosystem

Other Aspose products with agentic, build-validated example repositories:

Related Resources

Official Documentation

• Aspose.PDF for .NET Documentation — Guides, tutorials, and feature overviews
• API Reference — Complete class/method reference
• Release Notes — Version history and changelogs

Downloads & Packages

• NuGet Package — Install via dotnet add package Aspose.PDF
• Direct Downloads — MSI/ZIP installers and DLLs

Community & Support

• Aspose.PDF Forum — Community Q&A and official support
• Aspose Blog - PDF — Tutorials, tips, and product updates
• GitHub Issues — Bug reports and feature requests

Licensing & Purchase

• Purchase — Commercial license options
• Temporary License — Full-feature evaluation license

License

All examples use Aspose.PDF for .NET and require a valid license for production use. See licensing options.

Maintained by an agentic example generation workflow | For AI-friendly guidance, see AGENTS.md | Last updated: 2026-07-21