TPDFlib

Objeto central, criação de documentos, gerenciamento de documentos

Descrição

TPDFlib (unit Lib\PDFlibrary.pas) is the central class of PDF Library for Delphi. A single instance hosts one or more PDF documents at the same time: NewDocument starts an empty document, LoadFromFile loads an existing one, SelectDocument switches the active document and DocumentCount reports how many are open. All drawing, text, form, annotation, security, signature, extraction, rendering, printing and validation calls operate on the currently selected document

A unit PDFlibrary é a unit guarda-chuva: adicioná-la à sua cláusula uses traz toda a superfície pública, então a maioria dos programas só precisa de Uses PDFlibrary;

Sintaxe

Delphi

Uses PDFlibrary;

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

Parâmetros

Create / DestroyCiclo de vida da instância; liberá-la fecha todo documento aberto
NewDocumentInicia um novo documento PDF vazio e o seleciona
LoadFromFileCarrega um PDF existente do disco (opcionalmente com uma senha) e o seleciona
SelectDocumentTorna outro documento aberto o ativo
DocumentCountNúmero de documentos abertos no momento na instância
SaveToFileGrava o documento ativo no disco (atualizações incrementais mantêm assinaturas anteriores intactas)
LastErrorCodeCódigo numérico do erro mais recente; 0 quando a última chamada teve sucesso
Abort / AbortedCancela uma operação de longa duração de forma cooperativa e reporta o estado do cancelamento
OnProgress / OnOperationProgressCallbacks de progresso grosso e fino para operações longas
OnPasswordPede uma senha ao host quando um documento criptografado precisar de uma
LoggerOptional TPDFlibLogger instance receiving structured log records
MailProviderIPDFlibMailProvider opcional usado pelas funções de e-mail

Observações

As páginas de referência desta documentação descrevem os membros um a um, agrupados por tarefa: gerenciamento de documentos, layout de página, gráficos vetoriais, fontes e texto (incluindo stories HTML e fluxo de texto), imagens, formulários e JavaScript, anotações e links, outlines e destinos, segurança e assinaturas digitais, PDF marcado, conformidade PDF/A e PDF/UA, extração de conteúdo e acesso direto, renderização (SelectRenderer escolhe GDI+, Cairo ou PDFium), impressão, relatórios de preflight e integração com visualizador via TPDFlibViewer

A maioria dos membros existe em três sabores paralelos: como métodos TPDFlib que recebem WideString, como pontos de entrada DLL com prefixos DL (mais variantes ANSI com sufixo A para chamadores de narrow string, veja SetAnsiMode) e como métodos ActiveX/COM no objeto de automação PDFlib library. As páginas de cada membro mostram a sintaxe Delphi e a DLL lado a lado

Exemplo

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

Veja também

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