TPDFlib

Kernobjekt, Dokumenterstellung, Dokumentverwaltung

Beschreibung

TPDFlib (Unit Lib\PDFlibrary.pas) ist die zentrale Klasse von PDF Library for Delphi. Eine einzelne Instanz verwaltet gleichzeitig ein oder mehrere PDF-Dokumente: NewDocument beginnt ein leeres Dokument, LoadFromFile lädt ein vorhandenes, SelectDocument wechselt das aktive Dokument und DocumentCount meldet die Anzahl geöffneter Dokumente. Alle Aufrufe zum Zeichnen, für Text, Formulare, Anmerkungen, Sicherheit, Signaturen, Extraktion, Rendern, Drucken und Validieren wirken auf das aktuell ausgewählte Dokument

Die Unit PDFlibrary ist die übergeordnete Unit: Wenn Sie sie Ihrer uses-Klausel hinzufügen, wird die gesamte öffentliche Oberfläche eingebunden, sodass die meisten Programme nur Uses PDFlibrary; benötigen

Syntax

Delphi

Uses PDFlibrary;

Var
  PDF: TPDFlib;
Begin
  PDF:= TPDFlib.Create;
  Try
    ...
  Finally
    PDF.Free;
  End;
End;

Parameter

`Create` / `Destroy`	Lebenszyklus der Instanz; ihre Freigabe schließt jedes geöffnete Dokument
`NewDocument`	Startet ein neues leeres PDF-Dokument und wählt es aus
`LoadFromFile`	Lädt eine vorhandene PDF-Datei vom Datenträger, optional mit einem Kennwort, und wählt sie aus
`SelectDocument`	Macht ein anderes geöffnetes Dokument zum aktiven Dokument
`DocumentCount`	Anzahl der derzeit in der Instanz geöffneten Dokumente
`SaveToFile`	Schreibt das aktive Dokument auf den Datenträger; inkrementelle Aktualisierungen erhalten frühere Signaturen
`LastErrorCode`	Numerischer Code des neuesten Fehlers; 0, wenn der letzte Aufruf erfolgreich war
`Abort` / `Aborted`	Bricht einen lang laufenden Vorgang kooperativ ab und meldet den Abbruchzustand
`OnProgress` / `OnOperationProgress`	Grobe und detaillierte Fortschritts-Callbacks für lang laufende Vorgänge
`OnPassword`	Fordert beim Host ein Kennwort an, wenn ein verschlüsseltes Dokument eines benötigt
`Logger`	Optionale `TPDFlibLogger`-Instanz, die strukturierte Protokolldatensätze empfängt
`MailProvider`	Optionale `IPDFlibMailProvider`-Instanz, die von den E-Mail-Funktionen verwendet wird

Anmerkungen

Die Referenzseiten dieser Dokumentation beschreiben die Mitglieder einzeln und nach Aufgaben gruppiert: Dokumentverwaltung, Seitenlayout, Vektorgrafik, Schriften und Text einschließlich HTML-Storys und Textfluss, Bilder, Formulare und JavaScript, Anmerkungen und Links, Gliederungen und Ziele, Sicherheit und digitale Signaturen, Tagged PDF, PDF/A- und PDF/UA-Konformität, Inhaltsextraktion und Direktzugriff, Rendern (SelectRenderer wählt GDI+, Cairo oder PDFium), Drucken, Preflight-Berichte und Viewer-Integration über TPDFlibViewer

Die meisten Elemente liegen in drei parallelen Varianten vor: als TPDFlib-Methoden mit WideString, als DLL-Einstiegspunkte mit Präfix DL (zuzüglich ANSI-Varianten mit Suffix A für Aufrufer mit schmalen Zeichenfolgen, siehe SetAnsiMode) und als ActiveX/COM-Methoden des Automatisierungsobjekts PDFlib library. Die Seiten der einzelnen Elemente zeigen die Delphi- und DLL-Syntax nebeneinander

Beispiel

// Create a document, draw one line of text and save it
Uses PDFlibrary;

Procedure Demo;
Var
  PDF: TPDFlib;
Begin
  PDF:= TPDFlib.Create;
  Try
    PDF.NewDocument;
    PDF.AddStandardFont('Helvetica');
    PDF.PrintText(50, 750, 'Hello from PDF Library for Delphi');
    PDF.SaveToFile('hello.pdf');
  Finally
    PDF.Free;
  End;
End;

Siehe auch

DocumentationHome, GettingStarted, NewDocument, LoadFromFile, SelectDocument, DocumentCount, LastErrorCode, SelectRenderer, TPDFlibViewer, TPDFlibLogger