TPDFlib

Objet principal, création de documents, gestion de documents

Description

TPDFlib (unité Lib\PDFlibrary.pas) est la classe centrale de PDF Library for Delphi. Une instance gère simultanément un ou plusieurs documents PDF : NewDocument crée un document vide, LoadFromFile charge un document existant, SelectDocument change le document actif et DocumentCount indique combien sont ouverts. Tous les appels de dessin, texte, formulaire, annotation, sécurité, signature, extraction, rendu, impression et validation agissent sur le document sélectionné

L'unité PDFlibrary est l'unité générale : l'ajouter à uses importe toute la surface publique ; la plupart des programmes n'ont besoin que de Uses PDFlibrary;

Syntaxe

Delphi

Uses PDFlibrary;

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

Paramètres

Create / DestroyCycle de vie de l’instance ; sa libération ferme tous les documents ouverts
NewDocumentDémarre un nouveau document PDF vide et le sélectionne
LoadFromFileCharge un PDF existant depuis le disque, éventuellement avec un mot de passe, et le sélectionne
SelectDocumentRend actif un autre document ouvert
DocumentCountNombre de documents actuellement ouverts dans l’instance
SaveToFileÉcrit le document actif sur le disque (les mises à jour incrémentielles conservent intactes les signatures antérieures)
LastErrorCodeCode numérique de l’erreur la plus récente ; 0 si le dernier appel a réussi
Abort / AbortedAnnule de manière coopérative une opération longue et indique l'état de l'annulation
OnProgress / OnOperationProgressRappels de progression généraux et détaillés pour les opérations longues
OnPasswordDemande un mot de passe à l’hôte lorsqu’un document chiffré en a besoin
LoggerInstance facultative de TPDFlibLogger recevant les enregistrements de journal structurés
MailProviderIPDFlibMailProvider facultatif utilisé par les fonctions de courrier

Remarques

Les pages de référence de cette documentation décrivent les membres un par un, regroupés par tâche : gestion des documents, mise en page, graphiques vectoriels, polices et texte (y compris les récits HTML et le flux de texte), images, formulaires et JavaScript, annotations et liens, signets et destinations, sécurité et signatures numériques, PDF balisé, conformité PDF/A et PDF/UA, extraction de contenu et accès direct, rendu (SelectRenderer choisit GDI+, Cairo ou PDFium), impression, rapports de contrôle et intégration au lecteur via TPDFlibViewer

La plupart des membres existent sous trois formes parallèles : méthodes TPDFlib avec WideString, points d’entrée DLL préfixés DL avec variantes ANSI suffixées A (voir SetAnsiMode), et méthodes ActiveX/COM de l’objet d’automatisation PDFlib library. Les pages présentent côte à côte la syntaxe Delphi et DLL

Exemple

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

Voir aussi

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