TPDFlib

Obiekt podstawowy, tworzenie dokumentu, zarządzanie dokumentem

Opis

TPDFlib (moduł Lib\PDFlibrary.pas) jest centralną klasą PDF Library for Delphi. Jedna instancja obsługuje jednocześnie co najmniej jeden dokument PDF: NewDocument rozpoczyna pusty dokument, LoadFromFile wczytuje istniejący, SelectDocument przełącza aktywny dokument, a DocumentCount zgłasza liczbę otwartych dokumentów. Wszystkie wywołania rysowania, tekstu, formularzy, adnotacji, zabezpieczeń, podpisów, wyodrębniania, renderowania, drukowania i walidacji działają na aktualnie wybranym dokumencie

Moduł PDFlibrary jest modułem zbiorczym: dodanie go do klauzuli uses udostępnia cały publiczny interfejs, dlatego większość programów potrzebuje tylko Uses PDFlibrary;

Składnia

Delphi

Uses PDFlibrary;

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

Parametry

Create / DestroyCykl życia instancji; jej zwolnienie zamyka wszystkie otwarte dokumenty
NewDocumentRozpoczyna nowy, pusty dokument PDF i wybiera go
LoadFromFileWczytuje istniejący plik PDF z dysku (opcjonalnie z hasłem) i wybiera go
SelectDocumentUstawia inny otwarty dokument jako aktywny
DocumentCountLiczba dokumentów obecnie otwartych w instancji
SaveToFileZapisuje aktywny dokument na dysku (aktualizacje przyrostowe zachowują wcześniejsze podpisy)
LastErrorCodeKod liczbowy ostatniego błędu; 0, gdy ostatnie wywołanie zakończyło się powodzeniem
Abort / AbortedWspółdzielone anulowanie długotrwałej operacji i zgłaszanie stanu anulowania
OnProgress / OnOperationProgressOgólne i szczegółowe funkcje wywołania zwrotnego postępu dla długich operacji
OnPasswordProsi hosta o hasło, gdy wymaga go zaszyfrowany dokument
LoggerOpcjonalna instancja TPDFlibLogger otrzymująca ustrukturyzowane rekordy dziennika
MailProviderOpcjonalny IPDFlibMailProvider używany przez funkcje pocztowe

Uwagi

Strony dokumentacji opisują poszczególne elementy zgrupowane według zadań: zarządzanie dokumentami, układ stron, grafika wektorowa, czcionki i tekst (w tym historie HTML i przepływ tekstu), obrazy, formularze i JavaScript, adnotacje i łącza, konspekty i cele, zabezpieczenia i podpisy cyfrowe, Tagged PDF, zgodność PDF/A i PDF/UA, wyodrębnianie zawartości i dostęp bezpośredni, renderowanie (SelectRenderer wybiera GDI+, Cairo lub PDFium), drukowanie, raporty preflight oraz integracja z przeglądarką przez TPDFlibViewer

Większość elementów występuje w trzech równoległych postaciach: jako metody TPDFlib przyjmujące WideString, jako punkty wejścia DLL z prefiksem DL (oraz warianty ANSI z sufiksem A dla kodu używającego wąskich ciągów, zobacz SetAnsiMode) i jako metody ActiveX/COM obiektu automatyzacji PDFlib library. Strony poszczególnych elementów pokazują składnię Delphi i DLL obok siebie

Przykład

// 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;

Zobacz również

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