TPDFlib

Základní objekt, vytváření dokumentů, správa dokumentů

Popis

TPDFlib (unit Lib\PDFlibrary.pas) je centrální třídou PDF Library for Delphi. Jedna instance hostuje jeden nebo více PDF dokumentů najednou: NewDocument zakládá prázdný dokument, LoadFromFile načítá existující, SelectDocument přepíná aktivní dokument a DocumentCount hlásí, kolik jich je otevřených. Všechna volání pro kreslení, text, formuláře, anotace, zabezpečení, podpisy, extrakci, renderování, tisk i validaci pracují s aktuálně vybraným dokumentem

Unit PDFlibrary je zastřešující unit: jeho přidání do klauzule uses stáhne celý veřejný povrch, takže většina programů potřebuje jen Uses PDFlibrary;

Syntaxe

Delphi

Uses PDFlibrary;

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

Parametry

`Create` / `Destroy`	Životní cyklus instance; její uvolnění zavře každý otevřený dokument
`NewDocument`	Spustí nový, prázdný dokument PDF a vybere ho
`DocumentCount`	Počet dokumentů aktuálně otevřených v instanci
`SaveToFile`	Zapíše aktivní dokument na disk (přírůstkové aktualizace ponechají dřívější podpisy nedotčené)
`LastErrorCode`	Číselný kód poslední chyby; 0, když poslední volání uspělo
`Abort` / `Aborted`	Kooperativně zruší dlouhotrvající operaci a nahlásí stav zrušení
`OnProgress` / `OnOperationProgress`	Hrubé a jemné progress callbacky pro dlouhé operace
`Logger`	Optional `TPDFlibLogger` instance receiving structured log records
`MailProvider`	Volitelný `IPDFlibMailProvider` používaný mailovými funkcemi

Poznámky

Referenční stránky v této dokumentaci popisují členy jednoho po druhém, seskupené podle úloh: správa dokumentů, layout stránek, vektorová grafika, fonty a text (včetně HTML stories a toku textu), obrázky, formuláře a JavaScript, anotace a odkazy, osnovy a cíle, zabezpečení a digitální podpisy, tagované PDF, shoda PDF/A a PDF/UA, extrakce obsahu a direct access, renderování (SelectRenderer volí GDI+, Cairo nebo PDFium), tisk, preflight zprávy i integrace prohlížeče přes TPDFlibViewer

Většina členů existuje ve třech paralelních podobách: jako metody TPDFlib s parametry WideString, jako DLL vstupní body s předponou DL (plus ANSI varianty s příponou A pro volající s úzkými řetězci, viz SetAnsiMode) a jako ActiveX/COM metody na automatizačním objektu PDFlib library. Stránky jednotlivých členů ukazují syntaxi Delphi a DLL vedle sebe

Příklad

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

Viz také

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