Namespace LMKit.Document.Pdf
Classes
- EmbeddedPdfFile
A file embedded inside a PDF's attachment / associated-files tree, as returned by GetEmbeddedFiles(Attachment, CancellationToken). The typical case is a hybrid e-invoice: a Factur-X / ZUGFeRD PDF/A-3 carries its EN 16931 CII XML as an embedded file (commonly
factur-x.xmlorzugferd-invoice.xml). Content is already decoded and inflated.
- PdfAConversionOptions
Controls how an existing PDF document is converted to PDF/A.
- PdfAConversionReport
Describes the outcome of a PDF/A conversion: what was detected in the source document, what was repaired, and whether the produced file is believed to conform to the targeted level.
- PdfAConversionResult
Carries the outcome of an in-memory PDF/A conversion: the converted document bytes and the report describing how they were produced.
- PdfAConverter
Converts an existing PDF document to the PDF/A archival format (ISO 19005), producing a self-contained file suitable for long-term preservation and legal archiving.
- PdfEditor
Provides methods to reorder, rotate, and remove pages from a PDF document.
- PdfForm
Reads and fills the interactive form (AcroForm) of a PDF document. GetFields(string, CancellationToken) reports every form field with its name, kind, current value, options, and flags; Fill(string, PdfFormFillRequest, CancellationToken) writes values into the fields through the PDF form engine, which commits each value and regenerates the widget's appearance so the filled document renders correctly everywhere.
- PdfFormFieldInfo
A read-only description of one interactive form field widget: its name, kind, current value, options, flags, and page geometry. Instances are produced by GetFields(string, CancellationToken) as part of a PdfFormSnapshot.
- PdfFormFieldIssue
Explains why one requested field value was skipped during a PdfForm fill.
- PdfFormFieldValue
One value to write into a form field, addressed by the field's exact name as reported by GetFields(string, CancellationToken).
- PdfFormFillReport
Describes the outcome of a PdfForm fill: how many values were written, which were skipped and why, and how the output was finalized.
- PdfFormFillRequest
Describes what to write into a PDF's interactive form: the field values to set and whether the filled result is flattened.
- PdfFormFillResult
The filled PDF bytes together with the report describing what was written, as returned by Fill(string, PdfFormFillRequest, CancellationToken).
- PdfFormSnapshot
The interactive form fields of a PDF document at one point in time, as returned by GetFields(string, CancellationToken).
- PdfGenerationOptions
Controls how PDF documents are generated. Passed as an optional parameter to all PDF-producing APIs (image-to-PDF, searchable PDF, etc.).
- PdfInfo
Provides methods to retrieve PDF document metadata and structural information.
- PdfMerger
Provides methods to merge multiple PDF documents into a single PDF.
- PdfMetadata
Contains metadata information from a PDF document.
- PdfPageInfo
Contains information about a single PDF page.
- PdfRedactionArea
A rectangular region of one page whose content must be permanently removed. The geometry is carried by an IBounds in page points with the origin at the top-left corner of the page, matching the geometry returned by PdfSearch matches and layout text elements. The area implements IBounds itself, so it can be passed anywhere a bounds is expected.
- PdfRedactionOptions
Controls how PdfRedactor removes content. The defaults remove every content type intersecting a redaction area (text glyphs, image pixels, vector graphics, annotations, content nested in Form XObjects) and draw an opaque black box over each redacted area.
- PdfRedactionReport
Describes what a redaction pass removed or rewrote. Counters cover the whole document, including content nested inside Form XObjects.
- PdfRedactionRequest
Describes what to redact in a document. Areas, search terms, and pre-existing /Redact annotations can be combined in one request; everything matched is removed in a single pass.
- PdfRedactionResult
Carries the outcome of an in-memory redaction: the redacted document bytes and the report describing what was removed.
- PdfRedactor
Permanently removes content from PDF documents. Unlike drawing a black rectangle over content, redaction deletes the underlying data: text glyphs are removed from content streams, image pixels are scrubbed and re-encoded, vector graphics are trimmed, intersecting annotations are deleted, and content nested inside Form XObjects is processed per instance. The removed content cannot be recovered from the output file by text extraction, raw stream inspection, or rendering.
- PdfRenderOptions
Options shared by every render method on PdfRenderer. Holds only render-universal knobs; format-specific encoder parameters (PNG compression level, JPEG / WebP quality, BMP / TGA RLE) are passed directly to the matching
SavePageAs*/SavePagesAs*method, not stored here.
- PdfRenderProgressEventArgs
Progress data reported by PdfRenderer multi-page methods after each page is processed.
- PdfRenderer
Production-grade renderer for PDF pages. Covers every output format ImageBuffer can write, plus the packed multi-page TIFF combo, and exposes async + CancellationToken + progress on every multi-page operation. Accepts PDFs as file paths, streams, or byte arrays, and writes single-page output to files, streams, or byte arrays.
- PdfSearch
Provides text search operations for PDF documents.
- PdfSearchableMaker
Makes an existing PDF searchable by adding invisible text overlays to pages that lack embedded text. The original document structure, images, annotations, and metadata are fully preserved. The output always contains the same number of pages as the input; only the pages targeted by PageRange are OCRed.
- PdfSearchableMakerOptions
Configures the behavior of PdfSearchableMaker operations, including text detection strategy, page range, parallelism, progress reporting, and save options.
- PdfSplitter
Provides methods to physically split a PDF into separate documents by extracting specific page ranges.
- PdfSplitterProgressEventArgs
Progress data reported by PdfSplitter multi-output methods (
SplitToFiles) after each part is saved.
- PdfTextSearchResult
Represents the full result of a PDF text search operation.
- PdfUnlocker
Provides methods to remove password protection from a PDF document.
Structs
- PageTextOverlay
Associates a PageElement containing positioned text with a specific page index in a PDF document. Used by PdfSearchableMaker to add invisible text overlays to multiple pages in a single operation.
Enums
- DocumentPermissions
Flags specifying document permissions.
- PageOrientations
Specifies the rotation orientation of a PDF page.
- PdfAConformanceLevel
Identifies the PDF/A conformance level targeted by a conversion. All levels are B-level (visual reproduction) targets.
- PdfAConversionOptions.FallbackBehavior
Determines what happens when the document contains features that the conforming rewrite cannot repair (non-embedded fonts, DeviceCMYK content, LZW compression, or transparency for PDF/A-1 targets).
- PdfAFeatures
Document features relevant to PDF/A conformance, as detected by the native analysis pass. Mirrors the FPDFA_FEATURE_* flags of the patched pdfium build.
- PdfAFixes
Modifications performed by the native PDF/A sanitization pass. Mirrors the FPDFA_FIX_* flags of the patched pdfium build.
- PdfFormFieldKind
The kind of an interactive form field, as reported by GetFields(string, CancellationToken).
- PdfGenerationOptions.BinaryImageEncoding
Specifies how a 1-bit binary image is encoded when embedded in a PDF.
- PdfGenerationOptions.ImageEncoding
Specifies how a color or grayscale image is encoded when embedded in a PDF.
- PdfGenerationOptions.PdfVersion
Specifies the PDF file format version or PDF/A conformance level.
- PdfSaveOptions
Flags controlling how a PDF document is written to its output destination.
- PdfSearchableMaker.TextDetectionStrategy
Specifies the algorithm used to determine whether a page already contains searchable text. Only meaningful when Skip is active.
- PdfSearchableMaker.TextPageHandling
Specifies how pages that already contain embedded text are handled during the searchable PDF conversion.