Skip to content

PdfAPI.Core API reference

This page lists all public types exposed by PdfAPI.Core. Each type links to its full API reference page. Types are grouped by namespace; PdfAPI.Core.v1 and PdfAPI.Services.PdfSettings are excluded because they are not part of the compiled assembly (see Architecture).

Types

PdfAPI.Core

Type Kind Namespace Purpose
Document Class PdfAPI.Core In-memory and on-disk representation of a single file participating in a PDF operation.
DocumentRange Class PdfAPI.Core Pairs one document with the page ranges selected from it.
DocumentRangeFactory Class PdfAPI.Core Convenience construction of DocumentRange from bytes, a file path, or an existing document.
IPageRange Interface PdfAPI.Core Read contract for a page selection.
PageRange Class PdfAPI.Core Immutable page selection, including parsing of page-expression syntax.
PdfRequest Class PdfAPI.Core Base request contract for all PDF operations.
ConvertRequest Class PdfAPI.Core Single-document conversion request.
MergeRequest Class PdfAPI.Core Multi-document merge request.
ExtractPagesRequest Class PdfAPI.Core Page-extraction request.
PdfOptions Class PdfAPI.Core Per-request output and cleanup options.
PdfResult Class PdfAPI.Core Result contract returned by every operation.
PdfTrackingInfo Class PdfAPI.Core Immutable tracking snapshot for a document.
PdfTrackingMetadata Class PdfAPI.Core Encodes and decodes the file-name prefix convention carrying tracking metadata.
PdfException Class PdfAPI.Core Domain exception for invalid PDF input and load failures.
PdfClientService Class PdfAPI.Core Static, stateless iTextSharp-backed facade for PDF inspection, transformation, and validation.
Extensions Class PdfAPI.Core Display-formatting extension method for PdfFormat.
DocumentTypes Enum PdfAPI.Core Distinguishes input from output documents.
PdfConversionType Enum PdfAPI.Core The kind of PDF operation a request represents.
PdfFormat Enum PdfAPI.Core Output document format.
PdfProcessorType Enum PdfAPI.Core The processing engine that produced or should produce a result.
PdfStatus Enum PdfAPI.Core Lifecycle status of a tracked PDF operation.

PdfAPI.Core.Cache

Type Kind Namespace Purpose
CacheType Enum PdfAPI.Core.Cache Selects which cache store a request targets.
PdfCacheRequest Class PdfAPI.Core.Cache Request to read a cached PDF by source id.
PdfCacheCreationRequest Class PdfAPI.Core.Cache Request to write a PDF into the cache.
PdfCacheResult Class PdfAPI.Core.Cache Cache lookup or creation outcome.

PdfAPI.Core.Convert

Type Kind Namespace Purpose
SourceConversionType Enum PdfAPI.Core.Convert The originating source format behind a conversion.

Sources

  • PdfAPI.Core\PdfAPI.Core.csproj