PDFium Component Docs

Active Eigenschaft

Dieser API-Eintrag behält Bezeichner, Signaturen, Codeblöcke und PDF-Begriffe in ihrer Originalform.
Komponente: TPdfView  ·  Unit: PDFium
Aktiviert oder deaktiviert den Viewer, öffnet das gebundene PDF-Dokument und rendert die ausgewählte Seite.

Syntax

property Active: Boolean; // default False

Beschreibung

Wenn Active auf True gesetzt wird, weist das den Viewer an, das vom zugehörigen Pdf-Baustein referenzierte Dokument zu laden, die durch PageNumber angegebene Seite zu öffnen und eine Neuzeichnung auszulösen. Bei False wird die Seite geschlossen, der zwischengespeicherte Textseiten-Handle freigegeben, die Suchsitzung beendet und der sichtbare Bereich geleert.

Active ist der Hauptschalter des Viewers. Dokumentbezogene Eigenschaften wie PageCount, PageWidth, PageLabel und die indizierten Zugriffsfunktionen (Character, Bitmap, WebLink, etc.) liefern nur dann aussagekräftige Werte, wenn Active True ist und die verknüpfte Pdf-Instanz ein geladenes Dokument besitzt.

Wenn Pdf nil ist, erstellt und besitzt der Viewer beim ersten Setzen von Active auf True eine interne TPdf-Instanz, sodass ein Minimalprogramm nach dem Verknüpfen mit einer Datei einfach PdfView1.Pdf.FileName := ...; PdfView1.Active := True; aufrufen kann.

Hinweise

Beispiel

// An ein explizites TPdf binden und eine Datei öffnen.
PdfView1.Pdf := Pdf1;
Pdf1.FileName := 'C:\docs\sample.pdf';
PdfView1.Active := True;

// Im Code auf Öffnen und Schließen reagieren.
if PdfView1.Active then
  StatusBar1.SimpleText := Format('%d Seiten', [PdfView1.PageCount])
else
  StatusBar1.SimpleText := 'Kein Dokument geladen';

// Den Viewer schließen.
PdfView1.Active := False;

Siehe auch

Pdf, PageNumber, PageCount, ReloadPage, TPdf.Active