TPDFlib

Базовый объект, создание документов, управление документами

Описание

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

Модуль PDFlibrary — зонтичный модуль: добавление его в uses тянет весь публичный слой, поэтому большинству программ достаточно Uses PDFlibrary;

Синтаксис

Delphi

Uses PDFlibrary;

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

Параметры

`Create` / `Destroy`	Жизненный цикл экземпляра; его освобождение закрывает все открытые документы
`NewDocument`	Создает новый пустой PDF-документ и выбирает его
`LoadFromFile`	Загружает существующий PDF с диска (при желании с паролем) и выбирает его
`SelectDocument`	Делает другой открытый документ активным
`DocumentCount`	Число открытых в экземпляре документов
`SaveToFile`	Пишет активный документ на диск (инкрементальные обновления сохраняют прежние подписи)
`LastErrorCode`	Числовой код последней ошибки; 0, если предыдущий вызов прошёл успешно
`Abort` / `Aborted`	Кооперативно отменяет длительную операцию и сообщает состояние отмены
`OnProgress` / `OnOperationProgress`	Грубые и детальные колбэки прогресса для долгих операций
`OnPassword`	Запрашивает у хоста пароль, когда он нужен зашифрованному документу
`Logger`	Optional `TPDFlibLogger` instance receiving structured log records
`MailProvider`	Необязательный `IPDFlibMailProvider`, используемый почтовыми функциями

Примечания

Справочные страницы этой документации описывают члены по одному, сгруппированные по задачам: управление документами, разметка страниц, векторная графика, шрифты и текст (включая HTML-истории и текстовые потоки), изображения, формы и JavaScript, аннотации и ссылки, оглавление и назначения, безопасность и цифровые подписи, структурированный PDF, соответствие PDF/A и PDF/UA, извлечение содержимого и прямой доступ, рендеринг (SelectRenderer выбирает GDI+, Cairo или PDFium), печать, preflight-отчеты и интеграция просмотрщика через TPDFlibViewer

Большинство членов существует в трех параллельных вариантах: как методы TPDFlib с WideString, как точки входа DLL с префиксом DL (плюс ANSI-варианты с суффиксом A для клиентов с узкими строками, см. SetAnsiMode) и как методы ActiveX/COM на объекте автоматизации PDFlib library. Страницы членов показывают синтаксис Delphi и DLL бок о бок

Пример

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

См. также

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