TPDFlib

Objeto principal, criação de documentos, gestão de documentos

Descrição

TPDFlib (unidade Lib\PDFlibrary.pas) é a classe central da PDF Library for Delphi. Uma única instância aloja simultaneamente um ou mais documentos PDF: NewDocument inicia um documento vazio, LoadFromFile carrega um documento existente, SelectDocument muda o documento ativo e DocumentCount comunica quantos estão abertos. Todas as chamadas de desenho, texto, formulários, anotações, segurança, assinaturas, extração, processamento, impressão e validação operam sobre o documento atualmente selecionado

A unidade PDFlibrary é a unidade agregadora: adicioná-la à cláusula uses inclui toda a superfície pública, pelo que a maioria dos programas só necessita 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; a sua libertação fecha todos os documentos abertos
NewDocumentInicia um novo documento PDF vazio e seleciona-o
LoadFromFileCarrega um PDF existente do disco (opcionalmente com uma palavra-passe) e seleciona-o
SelectDocumentTorna ativo outro documento aberto
DocumentCountNúmero de documentos atualmente abertos na instância
SaveToFileEscreve o documento ativo no disco (as atualizações incrementais mantêm intactas as assinaturas anteriores)
LastErrorCodeCódigo numérico do erro mais recente; 0 quando a última chamada foi bem-sucedida
Abort / AbortedCancela cooperativamente uma operação de longa duração e comunica o estado do cancelamento
OnProgress / OnOperationProgressChamadas de retorno de progresso aproximado e detalhado para operações prolongadas
OnPasswordPede uma palavra-passe ao anfitrião quando um documento encriptado necessita de uma
LoggerInstância TPDFlibLogger opcional que recebe registos de diário estruturados
MailProviderIPDFlibMailProvider opcional utilizado pelas funções de correio

Observações

As páginas de referência desta documentação descrevem individualmente os membros, agrupados por tarefa: gestão de documentos, esquema de páginas, gráficos vetoriais, tipos de letra e texto (incluindo histórias HTML e fluxo de texto), imagens, formulários e JavaScript, anotações e ligações, marcadores e destinos, segurança e assinaturas digitais, Tagged PDF, conformidade PDF/A e PDF/UA, extração de conteúdo e acesso direto, processamento (SelectRenderer escolhe GDI+, Cairo ou PDFium), impressão, relatórios de pré-verificação e integração com o visualizador através de TPDFlibViewer

A maioria dos membros existe em três variantes paralelas: como métodos de TPDFlib que recebem WideString, como pontos de entrada DLL com prefixos DL (e variantes ANSI com sufixo A para chamadores de cadeias estreitas, consulte SetAnsiMode) e como métodos ActiveX/COM no objeto de automatização PDFlib library. As páginas de cada membro apresentam lado a lado a sintaxe Delphi e da DLL

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;

Consulte também

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