Документация PDFiumPas

PDFium VCL Справочник API

Вспомогательные модули

МодульОписание
FPdfAsyncДокументирует FPdfAsync и сохраняет имена API без изменений
FPdfMatrixДокументирует TPdfMatrix и сохраняет имена API без изменений
FPdfPreflightReportСоздаёт повторно используемые объекты отчётов preflight для PDF/A, PDF/UA, PDF/E, PDF/X, PDF/R и PDF/VT с экспортом в TXT / HTML / Markdown / JSON / CSV и подсчётом категорий проблем
FPdfThumbnailДокументирует TPdfThumbnailView и сохраняет имена API без изменений
TPdfStreamAdapterДокументирует TPdfStreamAdapter и сохраняет имена API без изменений
TPdfXObjectДокументирует TPdfXObject и сохраняет имена API без изменений

Методы компонента TPdf

Управление документами

МетодОписание
CreateDocumentСоздаёт новый пустой PDF-документ
LoadDocument(Data: TMemoryStream; Buffered: Boolean = True)Загружает PDF-документ из потока памяти
LoadDocument(Data: Pointer; Size: Integer; Buffered: Boolean = True)Загружает PDF-документ из буфера памяти
LoadDocumentЗагружает PDF-документ из FileName
LoadDocument(const Data: TBytes; Buffered: Boolean = True)Загружает PDF-документ из TBytes
LoadCustomDocument(AStream: TStream; AOwnsStream: Boolean = False)Потоково загружает PDF-документ из любого TStream через FPDF_LoadCustomDocument; PDFium по требованию извлекает блоки вместо копирования всего файла в память. AOwnsStream = True передаёт срок жизни потока экземпляру TPdf
SaveAs(Stream: TStream; Option: TSaveOption = saNone; PdfVersion: TPdfVersion = pvUnknown): BooleanСохраняет документ в поток. Когда Compressed имеет значение True, обеспечивает сжатие всех потоков через FlateDecode. Явно заданные цели от pv13 до pv17 нормализуются и проверяются, включая существующие переопределения каталога /Version в инкрементальном выводе; несовместимые более новые возможности PDF вызывают EPdfError. Сохранённые файлы без существующего OpenAction открываются на первой странице с масштабом Fit Height, если целевая версия это поддерживает. Пробные сборки применяют пробный водяной знак во время сохранения
SaveAs(const FileName: string; Option: TSaveOption = saNone; PdfVersion: TPdfVersion = pvUnknown): BooleanСохраняет документ в файл. Явно заданные цели от pv13 до pv17 нормализуются и проверяются, включая существующие переопределения каталога /Version в инкрементальном выводе; несовместимые более новые возможности PDF вызывают EPdfError. Сохранённые файлы без существующего OpenAction открываются на первой странице с масштабом Fit Height, если целевая версия это поддерживает. Пробные сборки применяют пробный водяной знак во время сохранения
ImportPages(Pdf: TPdf; const Range: string; PageNumber: Integer = 1): BooleanИмпортирует страницы из другого PDF-документа. Формат диапазона: '1,3,5-7'
ImportPreferences(Pdf: TPdf): BooleanИмпортирует настройки просмотра из другого PDF

Операции со страницами

МетодОписание
AddPage(PageNumber: Integer; Width, Height: Double)Добавляет новую страницу в указанную позицию с нумерацией от 1 и заданными размерами в пунктах (72 пункта = 1 дюйм). Передача 0 принимается как совместимый псевдоним для вставки первой страницы, и вставленная страница становится текущей
DeletePage(PageNumber: Integer)Удаляет страницу по указанному индексу
GetPageBox(Box: TPdfPageBox): TPdfRectangleЧитает выбранный page dictionary box с текущей страницы
RemoveObject(Index: Integer; DestroyObject: Boolean = True)Удаляет объект страницы с текущей страницы и пересоздаёт её содержимое
ReloadPageПерезагружает текущую страницу
SetPageBox(Box: TPdfPageBox; const Rectangle: TPdfRectangle)Устанавливает выбранный page dictionary box на текущей странице
UpdatePageПрименяет ожидающие изменения к текущей странице (вызывает FPDFPage_GenerateContent)

Операции с текстом

МетодОписание
Text(StartIndex: Integer = 0; Count: Integer = MaxInt): WStringИзвлекает текст с текущей страницы
TextInRectangle(Left, Top, Right, Bottom: Double): WStringИзвлекает текст из прямоугольной области (координаты страницы)
TextInRectangle(Rectangle: TPdfRectangle): WStringИзвлекает текст из прямоугольника
AddText(const Text, Font: WString; FontSize: Single; X, Y: Double; Color: TColor = clBlack; Alpha: Byte = $FF; Angle: Double = 0.0)Добавляет текст в указанной позиции с указанными шрифтом, цветом, прозрачностью и углом поворота
SetText(ObjectIndex: Integer; const Text: WString)Задаёт текст существующего текстового объекта (не документированный API PDFium, может вызвать проблемы с форматированием)
SetTextPositions(ObjectIndex: Integer; const Positions: TPdfSingleArray)Задаёт позиции отдельных символов для существующего текстового объекта. Позиции начинаются со второго символа и отсчитываются относительно начала текстового объекта
FindFirst(const Text: WString; Options: TSearchOptions = []; StartIndex: Integer = 0; DirectionUp: Boolean = True): IntegerНачинает поиск текста, возвращает индекс символа или -1, если ничего не найдено
FindNext: IntegerПродолжает поиск текста вперёд, возвращает индекс символа или -1
FindPrevious: IntegerПродолжает поиск текста назад, возвращает индекс символа или -1
CharacterIndexAtPos(X, Y, ToleranceX, ToleranceY: Double): IntegerGet character index at page position
RectangleCount(StartIndex: Integer = 0; Count: Integer = MaxInt): IntegerGet the number of text rectangles for a character range
ReadingUnits: TPdfReadingUnitsВозвращает единицы чтения уровня предложения для вспомогательного прослушивания и семантической навигации
DocumentReadingUnits: TPdfReadingUnitsСоздает записи TPdfReadingUnit уровня предложения для потока читаемого содержимого всего документа
PageWordBoxes: TPdfWordBoxesВозвращает словесные рамки с диапазонами FTextPage и прямоугольниками страницы для подсветки по словам
SetReadingWord(const Word: TPdfWordBox)Выделяет TPdfWordBox как текущее произносимое слово в TPdfView
ClearReadingWordОчищает текущую пословную оверлейную подсветку курсора чтения в TPdfView
TrackReadingWordAt(PageNumber, CharIndex: Integer): IntegerСопоставляет смещение символа страницы с содержащим его TPdfWordBox, выделяет слово и возвращает индекс слова
SelectWordBox(const Word: TPdfWordBox): BooleanВыбирает диапазон текста, описанный одним TPdfWordBox на текущей странице TPdfView
SelectWordSpan(const Words: TPdfWordBoxes; StartIndex, EndIndex: Integer): BooleanВыбирает последовательность TPdfWordBox на одной странице как одно выделение текста TPdfView
BuildReadingUnits(Fragments)Преобразует TPdfContentFragments в записи TPdfReadingUnit уровня предложения без загрузки pdfium.dll
NextReadingUnitOfKind(Units, CurrentIndex, Kind, GoForward)Находит следующую или предыдущую TPdfReadingUnit, у которой Kind совпадает с запрошенным TPdfContentFragmentKind
BuildWordBoxes(PageText)Разбивает текст страницы на записи TPdfWordBox с текстом слова и диапазонами символов FTextPage
WordBoxIndexAtCharIndex(Words, CharIndex)Сопоставляет индекс символа FTextPage с TPdfWordBox, который его содержит
SpokenTextAppend(var Spoken: TPdfSpokenText; const SpokenPart: WString; Page, StartIndex: Integer; SourceCount: Integer = -1)Добавляет один сопоставленный фрагмент произносимого текста к TPdfSpokenText
BuildSpokenTextFromWords(Words, FirstWord, LastWord)Создает TPdfSpokenText из непрерывного диапазона TPdfWordBox
SpokenToPageChar(Spoken, SpokenOffset, Page, CharIndex)Переводит смещение символа речи обратно в символ страницы PDF
EstimateSpokenWordIndex(Words, ElapsedMs, WordsPerMinute)Оценивает индекс текущего слова, когда движок речи не сообщает позицию слова

Операции с аннотациями

МетодОписание
CreateAnnotation(const Annotation: TPdfAnnotation)Создаёт новую аннотацию на текущей странице
DeleteAnnotation(Index: Integer)Удаляет аннотацию по индексу

Сведение форм

МетодОписание
GenerateFormAppearancesПересоздаёт потоки отображения /AP для каждого элемента формы на каждой странице (FPDF_FFLDraw). Вызывайте после присваивания FormField[] и перед SaveAs / FlattenPage / FlattenAllPages
FlattenPage(nFlag: Integer = FLAT_NORMALDISPLAY): IntegerСводит аннотации и элементы формы на текущей странице в статическое содержимое. Возвращает FLATTEN_SUCCESS, FLATTEN_NOTHINGTODO или FLATTEN_FAIL
FlattenAllPages(nFlag: Integer = FLAT_NORMALDISPLAY): BooleanСводит каждую страницу документа. Возвращает True, когда все страницы обработаны успешно
SetFormFieldFlags(Index: Integer; const Flags: TPdfFormFieldFlags)Задаёт флаги поля AcroForm для поля формы с указанным индексом аннотации на текущей странице
SetFormFieldFlagsAt(X, Y: Single; const Flags: TPdfFormFieldFlags)Задаёт флаги поля AcroForm для поля формы в указанных координатах страницы

Операции с вложениями

МетодОписание
CreateAttachment(const Name: WString): BooleanСоздаёт новое пустое вложение
DeleteAttachment(Index: Integer): BooleanУдаляет вложение по индексу

Операции с изображениями

МетодОписание
AddJpegImage(JpegImage: TStream; X, Y, Width, Height: Double): BooleanДобавляет JPEG-изображение из потока в указанной позиции и с указанным размером
AddPicture(Picture: TPicture; X, Y: Double)Добавляет изображение в позиции в исходном размере
AddPicture(Picture: TPicture; X, Y, Width, Height: Double)Добавляет изображение в позиции с указанным размером
AddImage(const FileName: string; X, Y, Width, Height: Double)Прямая вставка файла изображения (передаёт управление AddPicture через временный TPicture); принимает любой формат изображений, зарегистрированный в графических модулях VCL или LCL
AddImage(Bitmap: TBitmap; X, Y, Width, Height: Double)Вставляет pf32bit TBitmap напрямую без промежуточного TPicture; при нулевом bitmap вызывает EPdfError

Операции рисования

МетодОписание
CreatePath(X, Y: Single; FillMode; FillColor; FillAlpha; Stroke; StrokeColor; StrokeAlpha; StrokeWidth; LineCap; LineJoin; BlendMode)Создаёт контур, начинающийся в позиции (X, Y)
CreatePath(X, Y, Width, Height: Single; ...)Создаёт прямоугольный контур с заданными границами
MoveTo(X, Y: Single)Перемещает текущую точку в (X, Y)
LineTo(X, Y: Single)Рисует линию от текущей точки к (X, Y)
BezierTo(X1, Y1, X2, Y2, X3, Y3: Single)Рисует кривую Безье с двумя управляющими точками и конечной точкой
ClosePathЗамыкает текущий подконтур
AddPathДобавляет завершённый контур на текущую страницу

Рендеринг

МетодОписание
RenderPage(DeviceContext: HDC; Left, Top, Width, Height: Integer; Rotation; Options)Рендерит страницу в контекст устройства (HDC)
RenderPage(Left, Top, Width, Height: Integer; Rotation; Options; Color): TBitmapРендерит страницу в новое растровое изображение
RenderPage(Bitmap: TBitmap; Left, Top, Width, Height: Integer; Rotation; Options; Color)Рендерит страницу в существующее растровое изображение
RenderPageThumbnail(PageIndex, MaxWidth, MaxHeight: Integer): TBitmapРендерит любую страницу с нумерацией от единицы в назначенное вызывающим миниатюрное растровое изображение без изменения PageNumber и без уведомлений об изменении страницы
RenderTile(Left, Top, Width, Height, PageWidth, PageHeight: Integer; ...): TBitmapРендерит фрагмент страницы в новое растровое изображение
RenderTile(Bitmap: TBitmap; Left, Top, Width, Height, PageWidth, PageHeight: Integer; ...)Рендерит фрагмент в существующее растровое изображение
InvertPdfBitmap(Bitmap)Инвертирует RGB-каналы отрендеренного 32-битного TBitmap на месте для темного режима или высокого контраста
GrayscalePdfBitmap(Bitmap)Преобразует отрендеренный 32-битный TBitmap на месте в оттенки серого по яркости
DuotonePdfBitmap(Bitmap, DarkColor, LightColor)Отображает яркость отрендеренного растрового изображения на выбранные вызывающим тёмный и светлый цвета на месте

Преобразование координат

МетодОписание
DeviceToPage(X, Y, Left, Top, Width, Height: Integer; Rotation: TRotation; out PageX, PageY: Double): BooleanПреобразует координаты устройства в координаты страницы
PageToDevice(PageX, PageY: Double; Left, Top, Width, Height: Integer; Rotation: TRotation; out X, Y: Integer): BooleanПреобразует координаты страницы в координаты устройства

Свойства компонента TPdf

Опубликованные свойства (во время проектирования)

СвойствоТипОписание
AboutstringСведения о версии компонента (stored False)
ActiveBooleanУстановите True, чтобы загрузить и активировать документ, или False, чтобы закрыть его
FileNamestringПуть к загружаемому PDF-файлу
FormFillBooleanВключает интерактивное заполнение форм с поддержкой JavaScript (по умолчанию True)
PageNumberIntegerНомер текущей страницы (нумерация с 1, 0 когда документ не загружен)
PasswordstringПароль для открытия зашифрованных PDF-документов

Свойства документа

СвойствоТипR/WОписание
AuthorWStringRАвтор документа
CompressedBooleanR/WКогда True (по умолчанию), SaveAs дополнительно обрабатывает вывод, чтобы убедиться, что все потоки сжаты FlateDecode
CreationDateWStringRМетаданные даты создания документа
CreatorWStringRПриложение, создавшее документ
DocumentFPDF_DOCUMENTRНизкоуровневый дескриптор документа PDFium
FileIdentifier[IDType: TPdfFileIdentifierType]TBytesRПостоянные или изменяемые байты идентификатора trailer файла без завершающего байта PDFium
FormTypeTPdfFormTypeRТип формы: ftNone, ftAcroForm, ftXFAFull, ftXFAForeground
IsTaggedBooleanRTrue, если документ является tagged PDF
JavaScriptAction[Index]TPdfJavaScriptActionRДействие дерева имён JavaScript уровня документа по нулевому индексу
JavaScriptActionCountIntegerRКоличество действий дерева имён JavaScript уровня документа
JavaScriptActionsTPdfJavaScriptActionsRВсе действия дерева имён JavaScript уровня документа
KeywordsWStringRКлючевые слова документа
LanguageWStringR/WЯзык каталога документа (/Lang)
StructureElementsTPdfStructureElementsRСведённые логические элементы структуры для текущей страницы
MetaText[const Tag: string]WStringRПроизвольное значение метаданных по имени тега
ModifiedDateWStringRМетаданные даты последнего изменения
PageCountIntegerRОбщее количество страниц
PdfVersionTPdfVersionRФактическая версия PDF, включая допустимое переопределение каталога /Version, если оно присутствует
PermissionsLongWordRФлаги прав доступа документа
PrintCopiesIntegerRУказанное количество копий печати
PrintPageRangesTPdfPrintPageRangesRДиапазоны страниц для печати с нумерацией от 1 из предпочтений просмотра
PrintPaperHandlingTPrintPaperHandlingRПредпочтение обработки бумаги
PrintScalingBooleanRВключено ли масштабирование печати
ProducerWStringRПриложение, создавшее PDF
SubjectWStringRТема документа
TitleWStringRЗаголовок документа
UserPermissionsLongWordRФлаги прав пользователя
ViewerPreference[const Key: string]WStringRЗначение настройки просмотра по ключу
XFABooleanRTrue, если документ содержит формы XFA

Свойства страницы

СвойствоТипR/WОписание
PageFPDF_PAGERНизкоуровневый дескриптор страницы PDFium
PageBoundsTPdfRectangleRОграничивающий прямоугольник текущей страницы
PageBox[Box: TPdfPageBox]TPdfRectangleR/WMediaBox, CropBox, BleedBox, TrimBox или ArtBox для текущей страницы
PageHeightDoubleRВысота текущей страницы в пунктах
PageLabel[PageNumber: Integer]WStringRМетка страницы для заданного номера страницы
PageModeTPageModeRКак документ должен отображаться при открытии
PageRotationTRotationR/WПоворот текущей страницы (ro0, ro90, ro180, ro270)
PageWidthDoubleRШирина текущей страницы в пунктах
ThumbnailTBitmapRМиниатюрное растровое изображение текущей страницы
TransparentBooleanRTrue, если текущая страница содержит прозрачное содержимое

Свойства текста и символов

СвойствоТипОписание
Character[Index]WideCharЮникодный символ по индексу
CharacterAngle[Index]SingleУгол поворота символа в радианах
CharacterCountIntegerКоличество символов на текущей странице
CharacterFontSize[Index]DoubleРазмер шрифта символа по индексу; FontSize[Index] остаётся совместимым псевдонимом
CharacterFontWeight[Index]IntegerНачертание шрифта символа по индексу
CharacterGenerated[Index]BooleanTrue, если символ был сгенерирован, а не взят из исходного содержимого
CharacterIsHyphen[Index]BooleanTrue, если символ является дефисом
CharacterMapError[Index]BooleanTrue, если у символа есть ошибка сопоставления
CharacterOrigin[Index]TPdfPointИсходная точка символа
CharacterRectangle[Index]TPdfRectangleОграничивающий прямоугольник символа
Charcode[Index]WideCharКод символа по индексу
FindFPDF_SCHHANDLEНизкоуровневый дескриптор поиска PDFium
Rectangle[Index]TPdfRectangleПрямоугольник текста из последнего вызова RectangleCount
TextPageFPDF_TEXTPAGEНизкоуровневый дескриптор текстовой страницы PDFium

Свойства шрифтов

СвойствоТипОписание
FontAscent[Index; FontSize]SingleВерхний вынос шрифта, используемого текстовым объектом по индексу
FontBaseName[Index]WStringБазовое имя шрифта для текстового объекта по индексу
FontData[Index]TBytesСырые данные шрифта для текстового объекта по индексу
FontDescent[Index; FontSize]SingleНижний вынос шрифта, используемого текстовым объектом по индексу
FontFamilyName[Index]WStringИмя семейства шрифта для текстового объекта по индексу
FontHandle[Index]FPDF_FONTНизкоуровневый дескриптор шрифта PDFium для текстового объекта по индексу
FontIsEmbedded[Index]BooleanTrue, если шрифт текстового объекта встроен в PDF
FontItalicAngle[Index]IntegerНаклон курсивного начертания шрифта текстового объекта
FontSize[Index]DoubleСовместимый псевдоним для CharacterFontSize[Index]
FontWeight[Index]IntegerНачертание шрифта текстового объекта (например, 400 = normal, 700 = bold)

Свойства объектов

СвойствоТипОписание
ObjectCountIntegerКоличество объектов страницы на странице
ObjectType[Index]TObjectTypeТип: otUnknown, otText, otPath, otImage, otShading, otForm
ObjectBounds[Index]TPdfRectangleОграничивающий прямоугольник объекта
ObjectBitmap[Index]TBitmapРастровое представление объекта
ObjectHandle[Index]PointerНизкоуровневый дескриптор объекта
ObjectTransparent[Index]BooleanTrue, если объект прозрачен

Свойства изображений

СвойствоТипОписание
Bitmap[Index]TBitmapРастровое изображение объекта страницы по индексу
BitmapCountIntegerКоличество растровых объектов на странице
Image[Index]TPdfImageДанные изображения (Width, Height, Data) по индексу
ImageCountIntegerКоличество изображений на странице

Свойства аннотаций

СвойствоТипR/WОписание
Annotation[Index]TPdfAnnotationR/WПолучает или задаёт аннотацию по индексу
AnnotationCountIntegerRКоличество аннотаций на текущей странице

Свойства форм

СвойствоТипR/WОписание
FormField[Index]WStringR/WЗначение поля формы по индексу
FormFieldAt[X, Y: Single]WStringR/WЗначение поля формы в позиции на странице
FormFieldCountIntegerRКоличество полей формы на текущей странице
FormFieldInfo[Index]TPdfFormFieldInfoRСведения о поле формы по индексу
FormFieldInfoAt[X, Y: Single]TPdfFormFieldInfoRСведения о поле формы в позиции на странице
FocusedFormFieldValue()WStringRВозвращает значение текущего логического поля формы через FocusedFormFieldIndex без зависимости от интерактивного курсора
FocusedFormFieldName()WStringRВозвращает отображаемое имя текущего логического поля, предпочитая AlternateName, а затем Name
FocusedFormFieldDetails()TPdfFormFieldInfoRВозвращает TPdfFormFieldInfo для текущего логического поля формы
FormHandleFPDF_FORMHANDLERНизкоуровневый дескриптор заполнения формы
HasFormFieldAt[X, Y: Single]BooleanRTrue, если в позиции существует поле формы

Свойства вложений

СвойствоТипR/WОписание
Attachment[Index]TBytesR/WДанные вложения по индексу
AttachmentCountIntegerRКоличество вложений
AttachmentName[Index]WStringRИмя файла вложения по индексу
AttachmentType[Index]WStringRПодтип MIME вложения по индексу

Свойства навигации

СвойствоТипОписание
Bookmark[const Title: WString]TBookmarkНаходит закладку по заголовку
BookmarkChildren[const Bookmark: TBookmark]TBookmarksДочерние закладки указанной закладки
BookmarkFrom[Handle: FPDF_BOOKMARK]TBookmarkДанные закладки из дескриптора
BookmarksTBookmarksМассив закладок верхнего уровня
Destination[Index]TDestinationИменованное назначение по индексу
DestinationByName[const Name: WString]TDestinationИменованное назначение по имени
DestinationCountIntegerКоличество именованных назначений
HasBookmarkChildren[const Bookmark: TBookmark]BooleanTrue, если у закладки есть дочерние элементы
LinkAnnotation[PageNumber, Index]TLinkAnnotationАннотация-ссылка на заданной странице
LinkAnnotationCount[PageNumber]IntegerКоличество аннотаций-ссылок на странице
WebLink[PageNumber, Index]TWebLinkВеб-ссылка (URL) на заданной странице
WebLinkCount[PageNumber]IntegerКоличество веб-ссылок на странице

Свойства цифровой подписи

СвойствоТипОписание
Signature[Index]TPdfSignatureСведения о цифровой подписи по индексу
SignatureCountIntegerКоличество цифровых подписей в документе

События TPdf

СобытиеТипОписание
OnFormFieldEnterTPdfFormFieldEnterEventСрабатывает при входе в поле формы. Параметры: Sender: TObject; const Text: WString
OnFormFieldExitTNotifyEventСрабатывает, когда фокус покидает поле формы
OnPageChangeTNotifyEventСрабатывает при изменении текущей страницы
OnUnsupportedFeatureTPdfUnsupportedFeatureEventСрабатывает, когда PDF содержит неподдерживаемую возможность

Другие публичные методы и свойства

APIОписание
span class="keyword">property About: stringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ActiveЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure AddImage(const FileName: string; X, Y, Width, Height: Double)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function AddJpegImage(JpegImage: TStream; X, Y, Width, Height: Double): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure AddPage(PageNumber: Integer; Width, Height: Double)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AddPathЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure AddPicture(Picture: TPicture; X, Y: Double)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure AddText(const Text, Font: WString; FontSize: Single; X, Y: Double; Color: TColor = clBlack; Alpha: Byte = $FF; Angle: Double = 0.0)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AnnotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AnnotationCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Attachment[Index: Integer]: TBytesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AttachmentCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AttachmentNameЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AttachmentTypeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AuthorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
BezierToЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
BitmapЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
BitmapCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
BookmarkЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
BookmarkChildrenЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
BookmarkFromЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
BookmarksЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterAngleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterFontSizeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterFontWeightЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterGeneratedЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function CharacterIndexAtPos(X, Y, ToleranceX, ToleranceY: Double): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterIsHyphenЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterMapErrorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterOriginЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharacterRectangleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CharcodeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure ClearFormFieldFocusЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ClosePathЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CompressedЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
constructor Create(AOwner: TComponent); overrideСоздает компонент TPdf и инициализирует состояние документа, рендеринга, форм и кэша
span class="keyword">procedure CreateAnnotation(const Annotation: TPdfAnnotation)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CreateAttachmentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure CreateDocumentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure CreatePath(X, Y: Single; FillMode: TPdfFillMode = fmNone; FillColor: TColor = clBlack; FillAlpha: Byte = $FF; Stroke: Boolean = True; StrokeColor: TColor = clBlack; StrokeAlpha: Byte = $FF; StrokeWidth: Single = 1.0; LineCap: TPdfLineCap = lcDefault; LineJoin: TPdfLineJoin = ljDefault; BlendMode: TPdfBlendMode = bmDefault)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CreateXObjectFromPageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CreationDateЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
CreatorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
DeleteAnnotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function DeleteAttachment(Index: Integer): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure DeletePage(PageNumber: Integer)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
DestinationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
DestinationByNameЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
DestinationCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
destructor Destroy; overrideОсвобождает дескрипторы документа, состояние форм, кэши шрифтов, потоки и таймеры перед уничтожением TPdf
span class="keyword">function DeviceToPage(X, Y, Left, Top, Width, Height: Integer; Rotation: TRotation; out PageX, PageY: Double): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property DocumentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function DocumentReadableContent: TPdfContentFragmentsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function DocumentReadingUnits: TPdfReadingUnitsСоздает записи TPdfReadingUnit уровня предложения для потока читаемого содержимого всего документа
FileIdentifierЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FileNameЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FindЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FindFirst(const Text: WString; Options: TSearchOptions = []; StartIndex: Integer = 0; DirectionUp: Boolean = True): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FindNextЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FindPreviousЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FlattenAllPages(nFlag: Integer = FLAT_NORMALDISPLAY): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FlattenPage(nFlag: Integer = FLAT_NORMALDISPLAY): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FocusFormField(Index: Integer): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FocusNextFormField: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FocusPreviousFormField: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function FocusedFormFieldDetails: TPdfFormFieldInfoВозвращает TPdfFormFieldInfo для текущего логического поля формы
span class="keyword">function FocusedFormFieldIndex: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function FocusedFormFieldName: WStringВозвращает отображаемое имя текущего логического поля, предпочитая AlternateName и затем Name
span class="keyword">function FocusedFormFieldText: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function FocusedFormFieldValue: WStringВозвращает значение текущего логического поля формы через FocusedFormFieldIndex без зависимости от интерактивного курсора
FontAscentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontBaseNameЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontDataЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontDescentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontFamilyNameЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontHandleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontIsEmbeddedЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontItalicAngleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontSizeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FontWeightЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FormFieldЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FormFieldAtЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде
FormFieldCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FormFieldInfoЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FormFieldInfoAtЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FormFieldTabOrder: TPdfIntegerArrayЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FormFillЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
FormHandleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FormTypeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure GenerateFormAppearancesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function GetPageBoxЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
HasBookmarkChildrenЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
HasFormFieldAtЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ImageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ImageCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ImportNPagesToOneЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ImportPagesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ImportPagesByIndexЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ImportPreferences(Pdf: TPdf): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function InsertFormObjectFromXObject(XObject: TPdfXObject): FPDF_PAGEOBJECTЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
IsTaggedЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
JavaScriptActionЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
JavaScriptActionCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
JavaScriptActionsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
KeywordsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде
LanguageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде
LineToЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
LinkAnnotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
LinkAnnotationCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure LoadCustomDocument(AStream: TStream; AOwnsStream: Boolean = False)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure LoadDocumentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property MetaTextЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ModifiedDateЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
MovePagesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
MoveToЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ObjectBitmapЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ObjectBoundsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ObjectCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ObjectHandleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ObjectTransparentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ObjectTypeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnFormFieldEnterЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnFormFieldExitЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnPageChangeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnUnsupportedFeatureЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageBounds[Box: TPdfPageBox]: TPdfRectangleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageBox[Box: TPdfPageBox]: TPdfRectangleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PageHeightЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageLabel: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageMode: TPageModeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageNumber: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageRotation: TRotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function PageToDevice(PageX, PageY: Double; Left, Top, Width, Height: Integer; Rotation: TRotation; out X, Y: Integer): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageWidth: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function PageWordBoxes: TPdfWordBoxesВозвращает записи TPdfWordBox для слов на текущей странице TPdf с диапазонами символов и прямоугольниками страницы
span class="keyword">property PasswordЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PdfAConformanceЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PdfEConformanceЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PdfRConformanceЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PdfUaConformanceЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PdfVTConformanceЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PdfVersionЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PdfXConformanceЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PermissionsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PrintCopiesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PrintPageRangesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PrintPaperHandlingЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PrintScalingЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ProducerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ReadableContentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ReadablePageContent(PageNumber: Integer): TPdfReadableContentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function ReadingUnits: TPdfReadingUnitsСоздает записи TPdfReadingUnit уровня предложения из потока читаемого содержимого текущей страницы для вспомогательного прослушивания
RectangleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function RectangleCount(StartIndex: Integer = 0; Count: Integer = MaxInt): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure ReloadPageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure RemoveObject(Index: Integer; DestroyObject: Boolean = True)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure RenderPage(DeviceContext: HDC; Left, Top, Width, Height: Integer; Rotation: TRotation = ro0; Options: TRenderOptions = [])Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
RenderPageProgressiveЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function RenderPageThumbnail(PageIndex, MaxWidth, MaxHeight: Integer): TBitmapРендерит любую страницу, начиная с 1, в bitmap, который укладывается в запрошенные границы миниатюры
span class="keyword">function RenderTile(Left, Top, Width, Height, PageWidth, PageHeight: Integer; Rotation: TRotation = ro0; Options: TRenderOptions = []; Color: TColor = clWhite): TBitmapЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SaveAs(Stream: TStream; Option: TSaveOption = saNone; PdfVersion: TPdfVersion = pvUnknown): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SaveAsPdfAЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SaveAsPdfAToStream(Stream: TStream; const Options: TPdfASaveOptions): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SaveAsPdfEЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SaveAsPdfEToStream(Stream: TStream; const Options: TPdfESaveOptions): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SaveAsPdfRЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SaveAsPdfRToStream(Stream: TStream; const Options: TPdfRSaveOptions): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SaveAsPdfUaЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SaveAsPdfUaToStream(Stream: TStream; const Options: TPdfUaSaveOptions): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SaveAsPdfVTЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SaveAsPdfVTToStream(Stream: TStream; const Options: TPdfVTSaveOptions): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SaveAsPdfXЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SaveAsPdfXToStream(Stream: TStream; const Options: TPdfXSaveOptions): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SetFormFieldFlags(Index: Integer; const Flags: TPdfFormFieldFlags)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SetFormFieldFlagsAt(X, Y: Single; const Flags: TPdfFormFieldFlags)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SetPageBox(Box: TPdfPageBox; const Rectangle: TPdfRectangle)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SetTextЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SetTextPositions(ObjectIndex: Integer; const Positions: TPdfSingleArray)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SignatureЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SignatureCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
StructureElementsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
SubjectЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function Text(StartIndex: Integer = 0; Count: Integer = MaxInt): WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function TextInRectangle(Left, Top, Right, Bottom: Double): WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
TextPageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ThumbnailЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
TitleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
TransparentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure UpdatePageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property UserPermissionsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ValidatePdfA: TPdfAValidationResultЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ValidatePdfE: TPdfEValidationResultЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ValidatePdfR: TPdfRValidationResultЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ValidatePdfUa: TPdfUaValidationResultЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ValidatePdfVT: TPdfVTValidationResultЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function ValidatePdfX: TPdfXValidationResultЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ViewerPreferenceЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
WebLinkЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
WebLinkCountЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property XFAЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.

Компонент TPdfView

TPdfView — это прокручиваемый визуальный компонент для отображения PDF-документов и работы с ними. Он требует ссылку Pdf: TPdf

Опубликованные свойства (во время проектирования)

СвойствоТипПо умолчаниюОписание
AboutstringСведения о версии компонента
ActiveBooleanFalseАктивирует или деактивирует просмотрщик
CurrentCharIndexInteger0Индекс символа, выбранный приложением и сохранённый для совместимости
DisplayModeTPdfDisplayModedmSingleContinuousРежим отображения страниц (dmSingleContinuous, dmTwoPageContinuous, dmTwoPageContinuousWithCover)
OptionsTRenderOptions[reLcd]Параметры рендеринга (LCD text, annotations, grayscale и т. д.)
PageShadowSizeInteger0Необязательный размер падающей тени в пикселях; отрицательные значения приводятся к 0
PageShadowColorTColorclGrayЦвет заливки падающей тени, используемый когда PageShadowSize > 0
PageBorderColorTColorclBlackЦвет однопиксельной рамки страницы
SmoothScrollBooleanFalseАнимирует команды полос прокрутки строк и страниц в таймерных сегментах; перетаскивание ползунка остаётся мгновенным
LinkOptionsTPdfViewLinkOptions[loAutoGoto, loAutoOpenURI]Управляет автоматическим поведением goto, URI, launch и embedded-goto после событий щелчка по ссылке
AsyncRenderingBooleanFalseПоказывает оверлей загрузки, когда включено; при этом приложение по-прежнему управляет запуском фоновых задач
LoadingTextstringLoading...Текст, выводимый в оверлее AsyncRendering; пустая строка скрывает оверлей
LoadingColorTColorclYellowЦвет фона оверлея AsyncRendering
NightDuotoneInkTColor$0000C8FFЦвет чернил, используемый параметром рендеринга слабого зрения reNightDuotone
NightDuotonePaperTColorclBlackЦвет бумаги, используемый параметром рендеринга слабого зрения reNightDuotone
ReadingHighlightColorTColorclSkyBlueУправляет цветом более широкой оверлейной подсветки чтения
ReadingWordColorTColor$0000A5FFУправляет цветом оверлея для текущего пословного курсора чтения
ReadingWordFollowBooleanTrueУправляет тем, прокручивает ли TPdfView текущее произносимое слово в видимую область при отслеживании чтения
PageNumberInteger1Номер текущей страницы (нумерация с 1)
PdfTPdfnilReference to the TPdf component
RotationTRotationro0Display rotation (ro0, ro90, ro180, ro270)
ZoomDouble1.0Zoom level (1.0 = 100%)

Специфические опубликованные свойства TPdfView

СвойствоТипОписание
ActualSizeZoom[PageNumber]DoubleМасштаб для отображения страницы в её фактическом размере
CanvasTCanvasCanvas для пользовательского рисования в просмотрщике
CharacterAngle[Index]SingleУгол поворота символа в радианах
CharacterCountIntegerКоличество символов на текущей странице просмотра
CharacterFontSize[Index]DoubleРазмер шрифта символа по индексу; FontSize[Index] остаётся совместимым псевдонимом
CharacterFontWeight[Index]IntegerНачертание шрифта символа по индексу
CharacterOrigin[Index]TPointИсходная точка символа в координатах устройства просмотра
CharacterRectangle[Index]TRectГраницы символа в координатах устройства просмотра
FontAscent[Index; FontSize]SingleВерхний вынос шрифта, используемого текстовым объектом по индексу
FontBaseName[Index]WStringБазовое имя шрифта для текстового объекта по индексу
FontData[Index]TBytesСырые данные шрифта для текстового объекта по индексу
FontDescent[Index; FontSize]SingleНижний вынос шрифта, используемого текстовым объектом по индексу
FontFamilyName[Index]WStringИмя семейства шрифта для текстового объекта по индексу
FontHandle[Index]FPDF_FONTНизкоуровневый дескриптор шрифта PDFium для текстового объекта по индексу
FontIsEmbedded[Index]BooleanTrue, если шрифт текстового объекта встроен в PDF
FontItalicAngle[Index]IntegerНаклон курсивного начертания шрифта текстового объекта
FontWeight[Index]IntegerНачертание шрифта текстового объекта
PageHeightZoom[PageNumber]DoubleМасштаб для подгонки высоты страницы в просмотрщике
PageWidthZoom[PageNumber]DoubleМасштаб для подгонки ширины страницы в просмотрщике
PageZoom[PageNumber]DoubleМасштаб для подгонки всей страницы в просмотрщике
StructureElementsTPdfStructureElementsСведённые логические элементы структуры для текущей страницы просмотра
WindowHandleHWNDДескриптор окна компонента просмотра

Специфические методы TPdfView

МетодОписание
CharacterIndexAtPos(X, Y: Integer; ToleranceX, ToleranceY: Double): IntegerОпределяет символ рядом с точкой в координатах устройства просмотра; возвращает -1, если рядом нет символа
DeviceToPage(X, Y: Integer; out PageX, PageY: Double): BooleanПреобразует координаты устройства просмотра в координаты страницы
DeviceToPage(X, Y: Integer; var PageNumber: Integer; var PageX, PageY: Double): BooleanПреобразует координаты устройства просмотра в координаты страницы с определением страницы
DeviceToPage(Rectangle: TRect): TPdfRectangleПреобразует прямоугольник устройства просмотра в прямоугольник страницы
PageToDevice(PageX, PageY: Double; out X, Y: Integer): BooleanПреобразует координаты страницы в координаты устройства просмотра
PageToDevice(Rectangle: TPdfRectangle): TRectПреобразует прямоугольник страницы в прямоугольник устройства просмотра
LinkAnnotationAtPos(X, Y: Integer): IntegerВозвращает индекс аннотации-ссылки в экранной позиции
LinkAnnotationAtPos(X, Y: Integer; out PageNumber: Integer): IntegerВозвращает индекс аннотации-ссылки и номер страницы
WebLinkAtPos(X, Y: Integer): IntegerВозвращает индекс веб-ссылки в экранной позиции
WebLinkAtPos(X, Y: Integer; out PageNumber: Integer): IntegerВозвращает индекс веб-ссылки и номер страницы
PaintSelection(SelectionStart, SelectionEnd: Integer; Mask: TColor)Рисует подсветку текстового выделения
FocusedFormFieldValue: WStringВозвращает значение текущего логического поля формы через FocusedFormFieldIndex без зависимости от интерактивного курсора
FocusedFormFieldName: WStringВозвращает отображаемое имя текущего логического поля, предпочитая AlternateName и затем Name
FocusedFormFieldDetails: TPdfFormFieldInfoВозвращает TPdfFormFieldInfo для текущего логического поля формы
ReadingUnits: TPdfReadingUnitsВозвращает единицы чтения уровня предложения для вспомогательного прослушивания и семантической навигации
PageWordBoxes: TPdfWordBoxesВозвращает словесные рамки с диапазонами FTextPage и прямоугольниками страницы для подсветки по словам
SetReadingWord(const Word: TPdfWordBox)Выделяет TPdfWordBox как текущее произносимое слово в TPdfView
ClearReadingWordОчищает текущую пословную оверлейную подсветку курсора чтения в TPdfView
TrackReadingWordAt(PageNumber, CharIndex: Integer): IntegerСопоставляет смещение символа страницы с содержащим его TPdfWordBox, выделяет слово и возвращает индекс слова
RemoveObject(Index: Integer; DestroyObject: Boolean = True)Удаляет объект страницы с текущей страницы, пересоздаёт содержимое страницы и перерисовывает просмотрщик
GenerateFormAppearancesПересоздаёт потоки отображения /AP через связанный компонент TPdf (см. TPdf.GenerateFormAppearances)
FlattenPage(nFlag: Integer = FLAT_NORMALDISPLAY): IntegerСводит аннотации и элементы формы на текущей странице в статическое содержимое
SetFormFieldFlags(Index: Integer; const Flags: TPdfFormFieldFlags)Задаёт флаги поля AcroForm по индексу аннотации текущей страницы
SetFormFieldFlagsAt(X, Y: Integer; const Flags: TPdfFormFieldFlags)Задаёт флаги поля AcroForm в координатах устройства просмотра

VCL Inherited and Other Properties & Methods

APIОписание
span class="keyword">property About: stringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ActiveЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ActualSizeZoom[PageNumber: Integer]: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure AddImage(const FileName: string; X, Y, Width, Height: Integer); overloadЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function AddJpegImage(JpegImage: TStream; X, Y, Width, Height: Integer): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure AddPicture(Picture: TPicture; X, Y: Integer); overloadЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AlignЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property AllowUserPageChange: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property AllowUserTextSelection: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
AnchorsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Annotation[Index: Integer]: TPdfAnnotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property AnnotationCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property AsyncRendering: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Bitmap[Index: Integer]: TBitmapЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property BitmapCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Canvas: TCanvasЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ChangePageOnMouseScrolling: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Character[Index: Integer]: WideCharЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterAngle[Index: Integer]: SingleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterFontSize[Index: Integer]: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterFontWeight[Index: Integer]: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterGenerated[Index: Integer]: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function CharacterIndexAtPos(X, Y: Integer; ToleranceX, ToleranceY: Double): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterIsHyphen[Index: Integer]: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterMapError[Index: Integer]: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterOrigin[Index: Integer]: TPointЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CharacterRectangle[Index: Integer]: TRectЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Charcode[Index: Integer]: WideCharЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure ClearFormFieldFocusЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure ClearHighlightЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure ClearReadingHighlightЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
procedure ClearReadingWordОчищает текущую пословную оверлейную подсветку курсора чтения в TPdfView
span class="keyword">procedure ClearSelectionЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ConstraintsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function CopySelectionToClipboard: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
constructor Create(AOwner: TComponent); overrideСоздает элемент управления TPdfView и инициализирует рендеринг, прокрутку, выделение и взаимодействие с формами
span class="keyword">procedure CreateAnnotation(const Annotation: TPdfAnnotation)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property CurrentCharIndex: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure DeleteAnnotation(Index: Integer)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
destructor Destroy; overrideОсвобождает ресурсы просмотрщика, буферы рендеринга и подписки документа перед уничтожением TPdfView
span class="keyword">function DeviceToPage(X, Y: Integer; out PageX, PageY: Double): Boolean; overloadЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property DisplayMode: TPdfDisplayModeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property DragCursorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property DragKindЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property DragModeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
EnabledЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Find: FPDF_SCHHANDLEЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FindFirst(const Text: WString; Options: TSearchOptions= []; StartIndex: Integer= 0; DirectionUp: Boolean= True): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FindNext: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FindPrevious: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FitMode: TPdfFitModeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FlattenPage(nFlag: Integer = FLAT_NORMALDISPLAY): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FocusFormField(Index: Integer): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FocusNextFormField: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FocusPreviousFormField: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function FocusedFormFieldDetails: TPdfFormFieldInfoВозвращает TPdfFormFieldInfo для текущего логического поля формы
span class="keyword">function FocusedFormFieldIndex: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function FocusedFormFieldName: WStringВозвращает отображаемое имя текущего логического поля, предпочитая AlternateName и затем Name
span class="keyword">function FocusedFormFieldText: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function FocusedFormFieldValue: WStringВозвращает значение текущего логического поля формы через FocusedFormFieldIndex без зависимости от интерактивного курсора
span class="keyword">property FontAscent[Index: Integer; FontSize: Single]: SingleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontBaseName[Index: Integer]: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontData[Index: Integer]: TBytesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontDescent[Index: Integer; FontSize: Single]: SingleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontFamilyName[Index: Integer]: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontHandle[Index: Integer]: FPDF_FONTЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontIsEmbedded[Index: Integer]: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontItalicAngle[Index: Integer]: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontSize[Index: Integer]: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FontWeight[Index: Integer]: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FormCanRedo: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FormCanUndo: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FormField[Index: Integer]: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FormFieldAt[X, Y: Integer]: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FormFieldCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FormFieldInfo[Index: Integer]: TPdfFormFieldInfoЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property FormFieldInfoAt[X, Y: Integer]: TPdfFormFieldInfoЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FormFieldTabOrder: TPdfIntegerArrayЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FormRedo: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function FormUndo: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure GenerateFormAppearancesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function GetSelectedFormText: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property HasFormFieldAt[X, Y: Integer]: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function HasSelection: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property HighlightColor: TColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function HighlightSearchText(const Text: WString; MatchCase: Boolean= False; MatchWholeWord: Boolean= False): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Image[Index: Integer]: TPdfImageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ImageCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property LinkAnnotation[PageNumber, Index: Integer]: TLinkAnnotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function LinkAnnotationAtPos(X, Y: Integer; out PageNumber: Integer): Integer; overloadЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property LinkAnnotationCount[PageNumber: Integer]: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property LinkOptions: TPdfViewLinkOptionsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
LoadingColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
LoadingTextЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
property NightDuotoneInk: TColorУправляет цветом чернил, используемым параметром слабовидящего рендера reNightDuotone
property NightDuotonePaper: TColorУправляет цветом бумаги, используемым параметром слабовидящего рендера reNightDuotone
span class="keyword">property ObjectBitmap[Index: Integer]: TBitmapЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ObjectBounds[Index: Integer]: TPdfRectangleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ObjectCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ObjectHandle[Index: Integer]: PointerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ObjectTransparent[Index: Integer]: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ObjectType[Index: Integer]: TObjectTypeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Options: TRenderOptionsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Page: FPDF_PAGEЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageBorderColor: TColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageBounds: TPdfRectangleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageColor: TColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageHeight: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageHeightZoom[PageNumber: Integer]: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageLabel: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageNumber: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageRotation: TRotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PageShadowColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageShadowSize: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function PageToDevice(PageX, PageY: Double; out X, Y: Integer): Boolean; overloadЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageWidth: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property PageWidthZoom[PageNumber: Integer]: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function PageWordBoxes: TPdfWordBoxesВозвращает записи TPdfWordBox для слов на текущей странице TPdfView с диапазонами символов и прямоугольниками страницы
span class="keyword">property PageZoom[PageNumber: Integer]: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure PaintSelection(SelectionStart, SelectionEnd: Integer; Mask: TColor)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ParentShowHintЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Pdf: TPdfЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
PopupMenuЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ReadableContentЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property ReadingHighlightColor: TColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function ReadingUnits: TPdfReadingUnitsСоздает записи TPdfReadingUnit уровня предложения из текущей страницы TPdfView
span class="keyword">property ReadingWordColor: TColorУправляет цветом оверлея для текущего пословного курсора чтения
span class="keyword">property ReadingWordFollow: BooleanУправляет тем, прокручивает ли TPdfView текущее произносимое слово в видимую область при отслеживании чтения
span class="keyword">property Rectangle[Index: Integer]: TRectЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function RectangleCount(StartIndex: Integer = 0; Count: Integer = MaxInt): IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure ReloadPageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure RemoveObject(Index: Integer; DestroyObject: Boolean = True)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure RenderPage(DeviceContext: HDC; Left, Top, Width, Height: Integer; Rotation: TRotation = ro0; Options: TRenderOptions = [])Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function RenderTile(Left, Top, Width, Height, PageWidth, PageHeight: Integer; Rotation: TRotation = ro0; Options: TRenderOptions = []): TBitmapЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Rotation: TRotationЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SelectAllЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SelectAllFormText: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SelectTextRange(Page, StartIndex, Count: Integer): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function SelectWordBox(const Word: TPdfWordBox): BooleanВыбирает диапазон текста, описанный одним TPdfWordBox на текущей странице TPdfView
function SelectWordSpan(const Words: TPdfWordBoxes; StartIndex, EndIndex: Integer): BooleanВыбирает последовательность TPdfWordBox на одной странице как одно выделение текста TPdfView
span class="keyword">function SelectedText: WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SelectionCharCount: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property SelectionColor: TColorЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SelectionRanges: TPdfUserSelectionRangesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function SelectionRectangles: TPdfRectanglesЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SetFormFieldFlags(Index: Integer; const Flags: TPdfFormFieldFlags)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SetFormFieldFlagsAt(X, Y: Integer; const Flags: TPdfFormFieldFlags)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure SetReadingHighlight(const Rects: TPdfRectangles; PageNumber: Integer)Эта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
procedure SetReadingWord(const Word: TPdfWordBox)Выделяет TPdfWordBox как текущее произносимое слово в TPdfView
span class="keyword">function SetSelection(const Ranges: TPdfUserSelectionRanges): BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
ShowHintЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property SmoothScroll: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property StructureElements: TPdfStructureElementsЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
TabOrderЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
TabStopЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function Text(StartIndex: Integer = 0; Count: Integer = MaxInt): WStringЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function TextInRectangle(Left, Top, Right, Bottom: Integer): WString; overloadЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property TextPage: FPDF_TEXTPAGEЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Thumbnail: TBitmapЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property TouchЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
function TrackReadingWordAt(PageNumber, CharIndex: Integer): IntegerСопоставляет смещение символа страницы с содержащим его TPdfWordBox, выделяет слово и возвращает индекс слова
span class="keyword">property Transparent: BooleanЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">procedure UpdatePageЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
VisibleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property WebLink[PageNumber, Index: Integer]: TWebLinkЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">function WebLinkAtPos(X, Y: Integer; out PageNumber: Integer): Integer; overloadЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property WebLinkCount[PageNumber: Integer]: IntegerЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property WindowHandle: HWNDЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property Zoom: DoubleЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.

События TPdfView

СобытиеТипОписание
OnPageChangeTNotifyEventСрабатывает, когда отображаемая страница меняется при прокрутке
OnPageNumberChangedTNotifyEventСрабатывает, когда изменяется свойство PageNumber
OnAnnotationLinkClickTPdfViewAnnotationLinkClickEventСрабатывает перед автоматическим действием по аннотации-ссылке; установите Handled, чтобы подавить действие по умолчанию
OnWebLinkClickTPdfViewWebLinkClickEventСрабатывает перед автоматически обнаруженным действием по веб-ссылке; установите Handled, чтобы подавить ShellExecute
OnPaintTNotifyEventСрабатывает во время пользовательского рисования
span class="keyword">property OnAnnotationLinkClick: TPdfViewAnnotationLinkClickEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnCanResizeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
OnClickЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnConstrainedResizeЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnContextPopupЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
OnDblClickЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnDragDropЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnDragOverЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnEndDockЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnEndDragЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnEnterЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnExitЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnFormFieldFocusChange: TPdfFormFieldFocusEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnGestureЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnKeyDown: TKeyEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnKeyPress: TKeyPressEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnKeyUp: TKeyEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseActivateЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseDown: TMouseEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseEnterЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseLeaveЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseMove: TMouseMoveEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseUp: TMouseEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseWheel: TMouseWheelEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseWheelDownЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnMouseWheelUpЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnPageChange: TNotifyEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnPageNumberChanged: TNotifyEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnPaint: TNotifyEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnResize: TNotifyEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnSelectionChange: TNotifyEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnStartDockЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnStartDragЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.
span class="keyword">property OnWebLinkClick: TPdfViewWebLinkClickEventЭта запись API сохраняет идентификаторы, сигнатуры, блоки кода и термины PDF в исходном виде.

Компонент TPdfReadingSession

TPdfReadingSession — это нейтральная к TTS машина состояния для чтения вслух, которая координирует фрагменты TPdfSpokenText, обратные вызовы движка речи и подсветку словесного курсора TPdfView

Методы

МетодОписание
Create(AOwner: TComponent)Инициализирует пустую сессию с исходным расчетным темпом речи
LoadSpoken(const Chunks: TPdfSpokenTexts)Останавливает текущее воспроизведение и копирует фрагменты, которые нужно озвучить по порядку
PlayЗапускает воспроизведение с первого загруженного фрагмента
PlayFrom(ChunkIndex: Integer)Запускает воспроизведение с нулевого индекса фрагмента
PauseПереводит состояние из pssSpeaking в pssPaused и вызывает OnPauseRequest
ResumeВозобновляет паузу или повторно произносит текущий фрагмент, когда включен ResumeRestartsChunk
StopОтменяет воспроизведение, сбрасывает курсоры фрагмента и слова и очищает связанный словесный курсор TPdfView
FeedSpokenPosition(SpokenOffset: Integer)Сопоставляет смещение движка речи с символом страницы PDF и перемещает словесный курсор TPdfView
Tick(SpeechStillBusy: Boolean; ElapsedMs: Cardinal = 0)Переходит к следующему фрагменту, завершает воспроизведение или оценивает текущее слово, пока речь еще занята

Свойства

СвойствоТипОписание
StateTPdfReadingSessionStateТекущее состояние: pssIdle, pssSpeaking или pssPaused
ChunkCountIntegerКоличество загруженных фрагментов речи
CurrentChunkIntegerНулевой индекс активного фрагмента или -1, когда фрагмент не активен
CurrentWordIntegerНулевой индекс активного слова внутри текущего фрагмента или -1, когда индекс неизвестен
ViewTPdfViewПросмотрщик, который получает обновления словесного курсора
EstimatePacingBooleanИспользует прошедшее время для оценки позиции слова, если у движка речи нет сигнала позиции слова
EstimatedWordsPerMinuteIntegerСкорость речи, используемая при оценке темпа, по умолчанию 175
ResumeRestartsChunkBooleanЗаставляет Resume повторно озвучивать текущий фрагмент для движков, где пауза отменяет очередь речи

События

СобытиеТипОписание
OnSpeakTPdfReadingSpeakEventВызывается, когда хост должен произнести фрагмент
OnCancelRequestTNotifyEventВызывается, когда хост должен отменить речь
OnPauseRequestTNotifyEventВызывается, когда хост должен приостановить речь
OnResumeRequestTNotifyEventВызывается, когда хост должен возобновить речь без повторного старта фрагмента
OnChunkChangeTPdfReadingChunkEventВызывается при изменении активного фрагмента
OnWordChangeTPdfReadingWordEventВызывается при изменении активного слова
OnFinishedTNotifyEventВызывается после завершения последнего фрагмента

Компонент TPdfThumbnailView

Компонент для прокручиваемой навигации по миниатюрам страниц

Опубликованные свойства

СвойствоТипПо умолчаниюОписание
PdfTPdfnilСсылка на компонент TPdf, используемый для рендеринга миниатюр
CurrentPageIndexInteger0Выбранный индекс страницы с нумерацией от 1; 0 означает, что страница не выбрана
ThumbnailWidthInteger120Целевая ширина миниатюры, ограниченная поддерживаемым диапазоном
ThumbnailHeightInteger160Целевая высота миниатюры, ограниченная поддерживаемым диапазоном
TextColorTColorclBlackЦвет подписи с номером страницы
HoverColorTColorclMoneyGreenЦвет подсветки строки под наведённой миниатюрой
SelectionColorTColorclHighlightЦвет подсветки строки для CurrentPageIndex
BorderColorTColorclGrayЦвет рамки миниатюры

События

СобытияТипОписание
OnPageClickTPdfThumbnailClickEventСрабатывает при щелчке левой кнопкой мыши по строке миниатюры; APageIndex нумеруется с 1

Вспомогательный модуль FPdfAsync

ТипОписание
IPdfCancellationTokenДокументирует FPdfAsync и сохраняет имена API без изменений
IPdfCancellationTokenSourceИсточник отмены на стороне владельца, предоставляющий Token и Cancel
TPdfCancellationTokenSourceРеализация по умолчанию; используйте TPdfCancellationTokenSource.New
EPdfOperationCancelledИсключение, вызываемое ThrowIfCancelled после отмены
TPdfFutureStatuspfsSuccess, pfsCancelled, pfsFailure
TPdfFutureResult<T>Оболочка результата с Value, Status, ErrorMessage и помощниками IsSuccess / IsCancelled / IsFailure
TPdfFuture<T>.RunПомощник фоновой задачи без ожидания, который ставит ответ обратно в главный поток
PdfNoCancellationTokenОбщий токен, который никогда не отменяется

Вспомогательный модуль FPdfMatrix

ЧленОписание
TPdfMatrix.CreateСоздаёт единичную матрицу, явную матрицу из шести значений или копию из FS_MATRIX
ResetСбрасывает в единичную матрицу
MultiplyПостумножает на другую TPdfMatrix или на шесть значений FS_MATRIX
Translate / Scale / Rotate / SkewКомбинирует распространённые преобразования PDF-пространства
HorizontalFlip / VerticalFlip / CentralFlipКомбинирует зеркальные преобразования по осям
a, b, c, d, e, fСвойства элементов матрицы только для чтения
HandleСырое значение FS_MATRIX для API PDFium

Класс TPdfStreamAdapter

ЧленОписание
CreateДокументирует TPdfStreamAdapter и сохраняет имена API без изменений
DestroyОсвобождает состояние адаптера и владение потоком, когда это требуется
StreamБазовый Pascal-поток, используемый callback-ами PDFium
OwnsStreamПоказывает, освобождает ли адаптер поток
FileAccessЗапись обратных вызовов FPDF_FILEACCESS, используемая FPDF_LoadCustomDocument

Класс TPdfXObject

ЧленОписание
CreateДокументирует TPdfXObject и сохраняет имена API без изменений
DestroyЗакрывает обёрнутый дескриптор FPDF_XOBJECT до закрытия документа назначения
HandleСырое значение FPDF_XOBJECT, используемое API объекта страницы PDFium

Глобальные функции

ФункцияОписание
Loaded: BooleanВозвращает True, если выбранная библиотека PDFium загружена
LoadLibraryВручную загружает библиотеку PDFium
UnloadLibraryВыгружает библиотеку PDFium
DecodeDate(const Value: string; out DateTime: TDateTime; out DateTimeOffset: Integer): BooleanРазбирает строку даты PDF в TDateTime и смещение UTC
SetPdfPrintMode(PrintMode: TPdfPrintMode): BooleanВыбирает режим вывода печати PDFium Windows для последующего рендеринга печати
SetPdfPrintPaperHandlingDevMode(var DevMode: TDeviceMode; PrintPaperHandling: TPrintPaperHandling): BooleanСопоставляет подсказку duplex из предпочтений PDF-просмотрщика с Windows DEVMODE.dmDuplex
V8FeaturesAvailable: BooleanВозвращает True, когда загруженная DLL предоставляет вспомогательные экспорты PDFium V8
XfaBStrHelpersAvailable: BooleanВозвращает True, когда загруженная DLL предоставляет вспомогательные экспорты XFA FPDF_BSTR
GetRecommendedV8Flags: stringВозвращает рекомендованные PDFium флаги командной строки V8 или пустую строку, если загруженная DLL их не предоставляет
ValidatePdfUaStructureElements(const Elements: TPdfStructureElements): TPdfUaValidationIssuesПроверяет плоские данные TPdfStructureElement на структурные проблемы PDF/UA без загрузки pdfium.dll
ClassifyStructType(const TypeName: WString; out HeadingLevel: Integer): TPdfContentFragmentKindКлассифицирует имя типа структурного элемента как TPdfContentFragmentKind и необязательный уровень заголовка
FormFieldTabOrderForPage(FormHandle: FPDF_FORMHANDLE; Page: FPDF_PAGE): TPdfIntegerArrayВозвращает индексы аннотаций элементов формы страницы в порядке табуляции
FocusedFormFieldTextForPage(FormHandle: FPDF_FORMHANDLE; Page: FPDF_PAGE): WStringВозвращает текст сфокусированного элемента формы для дескриптора формы и страницы
NextFormFieldIndexForPage(FormHandle: FPDF_FORMHANDLE; Page: FPDF_PAGE; CurrentIndex: Integer; GoForward: Boolean): IntegerНаходит следующий или предыдущий индекс аннотации элемента формы в порядке табуляции страницы
ClearFocusedFormField(FormHandle: FPDF_FORMHANDLE): BooleanОчищает текущий сфокусированный элемент формы для дескриптора формы PDFium
ComputeSpreadPages(DisplayMode: TPdfDisplayMode; PageNumber, PageCount: Integer; out LeftPageNo, RightPageNo: Integer)Вычисляет номера левой и правой страниц для двухстраничных режимов отображения
BuildReadingUnits(const Fragments: TPdfContentFragments): TPdfReadingUnitsПреобразует фрагменты читаемого содержимого в единицы чтения уровня предложения
NextReadingUnitOfKind(const Units: TPdfReadingUnits; CurrentIndex: Integer; Kind: TPdfContentFragmentKind; GoForward: Boolean): IntegerНаходит следующую или предыдущую единицу чтения запрошенного семантического вида
BuildWordBoxes(const PageText: WString): TPdfWordBoxesРазбивает текст страницы на записи TPdfWordBox
WordBoxIndexAtCharIndex(const Words: TPdfWordBoxes; CharIndex: Integer): IntegerСопоставляет индекс символа страницы с индексом word-box
SpokenTextAppend(var Spoken: TPdfSpokenText; const SpokenPart: WString; Page, StartIndex: Integer; SourceCount: Integer = -1)Добавляет один сопоставленный фрагмент произносимого текста в речевой фрагмент
BuildSpokenTextFromWords(const Words: TPdfWordBoxes; FirstWord, LastWord: Integer): TPdfSpokenTextСоздаёт речевой фрагмент из диапазона word-box
SpokenToPageChar(const Spoken: TPdfSpokenText; SpokenOffset: Integer; out Page, CharIndex: Integer): BooleanПереводит смещение речевого текста обратно в индекс символа страницы
EstimateSpokenWordIndex(const Words: TPdfWordBoxes; ElapsedMs: Cardinal; WordsPerMinute: Integer): IntegerОценивает текущий индекс слова для движков без сигнала позиции слова
FPDF_RenderPageSkiaНизкоуровневая привязка PDFium для рендеринга содержимого страницы во внешний SkCanvas
FPDF_FFLDrawSkiaНизкоуровневая привязка PDFium для рисования полей формы и всплывающих аннотаций во внешний SkCanvas
PointsToInches(Points: Double): DoubleПреобразует пункты PDF в дюймы
PointsToPixels(Points, PixelsPerInch: Double): DoubleПреобразует пункты PDF в пиксели
PixelsToInches(Pixels, PixelsPerInch: Double): DoubleПреобразует пиксели в дюймы
PixelsToPoints(Pixels, PixelsPerInch: Double): DoubleПреобразует пиксели в пункты PDF
GetApplicationPath: stringВозвращает папку исполняемого файла, используемую как первый корень поиска PDFium DLL
IsWin64: BooleanВозвращает True, когда текущий процесс нацелен на Win64
BuildDllName(UseV8: Boolean): stringВозвращает pdfium.dll или pdfium.v8.dll для запрошенного режима V8
FindDllInPath(const DllName, SearchPath: string): stringНаходит именованную PDFium DLL в одной папке
FindDllInDllsTree(const DllName, StartPath, SubDir: string): stringИщет в папках DLLs\Win32 или DLLs\Win64 ниже начального пути
LoadPDFiumDll: stringОпределяет путь PDFium DLL по политике поиска компонента

Глобальные переменные

ПеременнаяТипПо умолчаниюОписание
LibraryNamestring'pdfium.dll'Имя стандартной PDFium DLL, которую нужно загрузить, когда EnableV8Engine имеет значение False
EnableV8EngineBooleanFalseУстановите True перед загрузкой, чтобы выбрать pdfium.v8.dll из соответствующей папки DLLs Win32 или Win64

Типовые сценарии использования

Реализация PDF-просмотрщика

procedure TMainForm.OpenPDF(const FileName: string);
begin
  Pdf.FileName := FileName;
  Pdf.Active := True;
  PdfView.Pdf := Pdf;
  PdfView.Active := True;
  StatusBar1.SimpleText := Format('Loaded: %s (%d pages)',
    [ExtractFileName(FileName), Pdf.PageCount]);
end;

Создание PDF со сжатием

Pdf.CreateDocument;
Pdf.Compressed := True;
Pdf.Active := True;
Pdf.AddPage(0, 595, 842);
Pdf.AddText('Hello World!', 'Arial', 24, 100, 700, clBlack, $FF, 0.0);
Pdf.SaveAs('output.pdf');
Pdf.Active := False;

Извлечение текста

Pdf.FileName := 'document.pdf';
Pdf.Active := True;
for I := 1 to Pdf.PageCount do
begin
  Pdf.PageNumber := I;
  Memo1.Lines.Add(Format('--- Page %d ---', [I]));
  Memo1.Lines.Add(Pdf.Text);
end;
Pdf.Active := False;

Обработка полей формы

Pdf.FileName := 'form.pdf';
Pdf.Active := True;
Pdf.PageNumber := 1;
for I := 0 to Pdf.FormFieldCount - 1 do
begin
  FieldInfo := Pdf.FormFieldInfo[I];
  case FieldInfo.FieldType of
    fiTextField:
      Pdf.FormField[I] := 'New Value';
    fiCheckBox:
      Pdf.FormField[I] := 'Yes';
  end;
end;
Pdf.SaveAs('filled_form.pdf');
Pdf.Active := False;

Сведение заполненной формы

// Bake form values into permanent (non-editable) page content
Pdf.FileName := 'form.pdf';
Pdf.Active := True;
Pdf.FormField[0] := 'John Smith';
Pdf.FormField[1] := 'Yes';
Pdf.GenerateFormAppearances;          // step 1: refresh /AP from /V
Pdf.FlattenAllPages(FLAT_NORMALDISPLAY); // step 2: flatten all pages
Pdf.SaveAs('flattened.pdf');           // step 3: save
Pdf.Active := False;