Table of Contents

Interface IPdfEngine

Namespace
PdfEngine
Assembly
PdfEngine.Abstractions.dll

Root PDF processing engine contract that opens documents and provides engine subsystems.

public interface IPdfEngine : IDisposable
Inherited Members

Properties

AnnotationService

Reads and writes annotations.

IPdfAnnotationService AnnotationService { get; }

Property Value

IPdfAnnotationService

EngineName

A display name of the engine.

string EngineName { get; }

Property Value

string

EngineVersion

The engine version, for diagnostics.

string EngineVersion { get; }

Property Value

string

FormService

Reads and fills interactive form fields.

IPdfFormService FormService { get; }

Property Value

IPdfFormService

PageOrganizer

Inserts, deletes, rotates, extracts and splits pages.

IPdfPageOrganizerService PageOrganizer { get; }

Property Value

IPdfPageOrganizerService

RedactionService

Marks and applies redactions.

IPdfRedactionService RedactionService { get; }

Property Value

IPdfRedactionService

Renderer

Renders pages to pixels.

IPdfRenderer Renderer { get; }

Property Value

IPdfRenderer

SaveService

Saves documents and exports pages as images.

IPdfSaveService SaveService { get; }

Property Value

IPdfSaveService

SignatureService

Reads and verifies digital signatures.

IPdfSignatureService SignatureService { get; }

Property Value

IPdfSignatureService

TextService

Extracts and searches text.

IPdfTextService TextService { get; }

Property Value

IPdfTextService

Methods

OpenDocumentAsync(byte[], string?, CancellationToken)

Opens a PDF from bytes in memory.

ValueTask<IPdfDocument> OpenDocumentAsync(byte[] pdfBytes, string? password = null, CancellationToken cancellationToken = default)

Parameters

pdfBytes byte[]

The complete PDF file.

password string

The password of an encrypted document, or null.

cancellationToken CancellationToken

Cancels the operation.

Returns

ValueTask<IPdfDocument>

The open document. Dispose it when you no longer need it.

OpenDocumentAsync(string, string?, CancellationToken)

Opens a PDF file.

ValueTask<IPdfDocument> OpenDocumentAsync(string filePath, string? password = null, CancellationToken cancellationToken = default)

Parameters

filePath string

The path of the PDF file.

password string

The password of an encrypted document, or null.

cancellationToken CancellationToken

Cancels the operation.

Returns

ValueTask<IPdfDocument>

The open document. Dispose it when you no longer need it.