PDFium VCL API Reference

Helper Units

TPdf Component Methods

Document Management

Page Operations

Text Operations

Annotation Operations

Form Flattening

XFA Operations

Attachment Operations

Image Operations

Drawing Operations

Rendering

Coordinate Conversion

PAdES Digital Signatures

TPdf Component Properties

Published Properties (Design-Time)

Document Properties

Page Properties

Text and Character Properties

Font Properties

Object Properties

Image Properties

Annotation Properties

Form Properties

Attachment Properties

Navigation Properties

Digital Signature Properties

TPdf Events

Other Public Methods and Properties

TPdfView Component

TPdfView is a scrollable visual control for displaying and interacting with PDF documents. It requires a Pdf: TPdf reference.

Published Properties (Design-Time)

TPdfView-Specific Public Properties

TPdfView-Specific Methods

VCL Inherited and Other Properties & Methods

TPdfView Events

TPdfReadingSession Component

TPdfReadingSession is a TTS-neutral read-aloud state machine that coordinates TPdfSpokenText chunks, host speech-engine callbacks, and TPdfView word-cursor highlighting.

Methods

Properties

Events

TPdfThumbnailView Component

TPdfThumbnailView is a scrollable side-panel control from the FPdfThumbnail unit. It links to a TPdf component and renders one page thumbnail per row for page navigation.

Published Properties

Events

Data Types and Enumerations

Core Types

Search and Render Options

Drawing Types

Annotation Types

Form Types

Record Types

FPdfAsync Helper Unit

FPdfMeasure Helper Unit

FPdfMatrix Helper Unit

PDFium Helper Classes

Global Functions

Global Variables

Common Usage Patterns

PDF Viewer Implementation

procedure TMainForm.OpenPDF(const FileName: string);
begin
  Pdf.FileName := FileName;
  Pdf.Active := True;
  PdfView.Pdf := Pdf;
  PdfView.Active := True;
  StatusBar1.SimpleText := Format('Loaded: %s (%d pages)',
    [ExtractFileName(FileName), Pdf.PageCount]);
end;

Create PDF with Compression

Pdf.CreateDocument;
Pdf.Compressed := True;
Pdf.Active := True;
Pdf.AddPage(0, 595, 842);
Pdf.AddText('Hello World!', 'Arial', 24, 100, 700, clBlack, $FF, 0.0);
Pdf.SaveAs('output.pdf');
Pdf.Active := False;

Text Extraction

Pdf.FileName := 'document.pdf';
Pdf.Active := True;
for I := 1 to Pdf.PageCount do
begin
  Pdf.PageNumber := I;
  Memo1.Lines.Add(Format('--- Page %d ---', [I]));
  Memo1.Lines.Add(Pdf.Text);
end;
Pdf.Active := False;

Form Field Processing

Pdf.FileName := 'form.pdf';
Pdf.Active := True;
Pdf.PageNumber := 1;
for I := 0 to Pdf.FormFieldCount - 1 do
begin
  FieldInfo := Pdf.FormFieldInfo[I];
  case FieldInfo.FieldType of
    fiTextField:
      Pdf.FormField[I] := 'New Value';
    fiCheckBox:
      Pdf.FormField[I] := 'Yes';
  end;
end;
Pdf.SaveAs('filled_form.pdf');
Pdf.Active := False;

Flatten a Filled Form

// Bake form values into permanent (non-editable) page content
Pdf.FileName := 'form.pdf';
Pdf.Active := True;
Pdf.FormField[0] := 'John Smith';
Pdf.FormField[1] := 'Yes';
Pdf.GenerateFormAppearances;          // step 1: refresh /AP from /V
Pdf.FlattenAllPages(FLAT_NORMALDISPLAY); // step 2: flatten all pages
Pdf.SaveAs('flattened.pdf');           // step 3: save
Pdf.Active := False;