PDFium Component Docs

TPdf component

Unit: PDFium
TPdf
Gebruik het component TPdf om PDF-documenten te openen, te navigeren, tekst te extraheren en te bewerken

Voorbeeld

Pdf.FileName := 'document.pdf';
Pdf.Password := 'password';
Pdf.Active := True; // open PDF document
Pdf.PageNumber := 1; // select page
ShowMessage(Pdf.Text); // extract text

Types

type TBookmark = record
  Handle: FPDF_BOOKMARK;
  Title: WString;
  PageNumber: Integer;
  Destination: TDestination;
  DescendantCount: Integer;
  IsOpen: Boolean;
  Action: TPdfAction;
  ActionPageNumber: Integer;
  ActionDestination: TDestination;
  ActionPath: WString;
  HasColor: Boolean;
  Color: TColor;
end;

type TBookmarks = array of TBookmark;

Bladwijzerdata

 

type TDestination = record
  Handle: FPDF_DEST;
  Name: WString;
  PageNumber: Integer;
  ViewMode: TPdfDestinationViewMode;
  ViewParameterCount: Integer;
  ViewParameters: TPdfDestinationViewParameters;
  HasX: Boolean;
  X: Single;
  HasY: Boolean;
  Y: Single;
  HasZoom: Boolean;
  Zoom: Single;
end;

Data van benoemde bestemmingen

 

type TPdfDestinationViewMode = (dvmUnknown, dvmXYZ, dvmFit, dvmFitHorizontal, dvmFitVertical, dvmFitRectangle, dvmFitBoundingBox, dvmFitBoundingBoxHorizontal, dvmFitBoundingBoxVertical);

type TPdfDestinationViewParameters = array [0..3] of Single;

Weergavemodus van een bestemming en de bijbehorende geordende native parameters

 

type TLinkAnnotation = record
  Handle: FPDF_LINK;
  Rectangle: TPdfRectangle;
  PageNumber: Integer;
  Action: TPdfAction;
  ActionPageNumber: Integer;
  ActionPath: WString;
  Points: array of TQuadrilateralPoint;
end;

type TLinkAnnotations = array of TLinkAnnotation;

type TQuadrilateralPoint = array [1..4] of TPdfPoint;

Linkannotatiedata

 

type TPdfPermission = (permPrint, permModify, permCopy, permAnnotate, permFillForms, permAccessibility, permAssemble, permPrintHighQuality);

type TPdfPermissions = set of TPdfPermission;

Getypeerde documentrechten-vlaggen, gedecodeerd uit het native rechtenmasker

 

type TPdfDocumentMetadata = record
  Title: WString;
  Author: WString;
  Subject: WString;
  Keywords: WString;
  Creator: WString;
  Producer: WString;
  CreationDate: WString;
  ModifiedDate: WString;
end;

Eén momentopname van de standaardvelden van de Info-dictionary van het document

 

type TObjectType = (otUnknown, otText, otPath, otImage, otShading, otForm);

Bepaalt het type van het PDF-object

 

type TPageMode = (pmNone, pmOutline, pmThumbs, pmFullScreen, pmOptionalContentGroup, pmAttachments, pmUnknown);

Bepaalt hoe het PDF-document bij het openen moet worden weergegeven

 

type TPdfAction = (acUnsupported, acGoto, acGotoRemote, acUri, acLaunch);

Bepaalt het type van een actie die bij een bladwijzeritem hoort

 

type TPdfAnnotation = record
  Subtype: TPdfAnnotationSubtype;
  Flags: TPdfAnnotationFlags;
  HasColor: Boolean;
  Color: TColor;
  ColorAlpha: Byte;
  HasInteriorColor: Boolean;
  InteriorColor: TColor;
  InteriorColorAlpha: Byte;
  HasAttachmentPoints: Boolean;
  AttachmentPoints: TQuadrilateralPoint;
  Rectangle: TPdfRectangle;
  ContentsText: WString;
  AuthorText: WString;
end;

Annotatiedata

 

type TPdfAnnotationFlag = (afInvisible, afHidden, afPrint, afNoZoom, afNoRotate, afNoView, afReadOnly, afLocked, afToggleNoView);

type TPdfAnnotationFlags = set of TPdfAnnotationFlag;

Annotatievlaggen

 

type TPdfAnnotationSubtype = (anUnknown, anText, anLink, anFreeText, anLine, anSquare, anCircle, anPolygon, anPolyLine, anHighlight, anUnderline, anSquiggly, anStrikeout, anStamp, anCaret, anInk, anPopup, anFileAttachment, anSound, anMovie, anWidget, anScreen, anPrinterMark, anTrapNet, anWaterMark, anThreed, anRichMedia, anXfaWidget, anRedact);

Het annotatiesubtype

 

type TPdfBlendMode = (bmDefault, bmColor, bmColorBurn, bmColorDodge, bmDarken, bmDifference, bmExclusion, bmHardLight, bmHue, bmLighten, bmLuminosity, bmMultiply, bmNormal, bmOverlay, bmSaturation, bmScreen, bmSoftLight);

Bepaalt hoe lagen in elkaar worden gemengd

 

type TPdfDisplayMode = (dmSingleContinuous, dmTwoPageContinuous, dmTwoPageContinuousWithCover);

Bepaalt hoe de pagina's van het PDF-document worden weergegeven

 

type TPdfFeature = (feUnknown, feXfaForm, fePortableCollection, feAttachment, feSecurity, feSharedReview, feSharedFormAcrobat, feSharedFormFilesystem, feSharedFormEmail, fe3dAnnotation, feMovieAnnotation, feSoundAnnotation, feScreenMediaAnnotation, feScreenRichMediaAnnotation, feAttachmentAnnotation, feSignatureAnnotation);

Documentfeature die door het event OnUnsupportedFeature wordt gerapporteerd

 

type TPdfFillMode = (fmNone, fmAlternate, fmWinding);

Bepaalt hoe vulgebieden worden gevormd wanneer een pad zichzelf kruist

 

type TPdfFormFieldFlag = (ffReadOnly, ffRequired, ffNoExport, ffMultiline, ffChoiceCombo, ffChoiceEdit, ffPassword, ffChoiceMultiSelect);

type TPdfFormFieldFlags = set of TPdfFormFieldFlag;

Formulierveldvlaggen

 

type TPdfFormFieldInfo = record
  Name: WString;
  AlternateName: WString;
  FieldType: TPdfFormFieldType;
  Flags: TPdfFormFieldFlags;
  OptionLabels: array of WString;
  OptionSelected: array of Boolean;
  FontSize: Single;
  Checked: Boolean;
  ExportValue: WString;
  GroupCount: Integer;
  GroupIndex: Integer;
end;

Formulierveldinformatie

 

type TPdfFormFieldType = (fiUnknown, fiPushButton, fiCheckBox, fiRadioButton, fiComboBox, fiListBox, fiTextField, fiSignature);

Bepaalt het type van het formulierveld

 

type TPdfFormType = (ftUnknown, ftNone, ftAcroForm, ftXfaFull, ftXfaForeground);

Bepaalt het type formulieren in het PDF-document

 

type TPdfImage = record
  Width: Integer;
  Height: Integer;
  Data: TBytes;
end;

Grootte in pixels en data van het PDF-afbeeldingsobject

 

type TPdfLineCap = (lcDefault, lcButt, lcRound, lcProjectingSquare);

De vorm die aan de uiteinden van open subpaden wordt gebruikt

 

type TPdfLineJoin = (ljDefault, ljMiter, ljRound, ljBevel);

De vorm die in de hoeken van gestreepte paden wordt gebruikt

 

type TPdfPoint = record
  X, Y: Double;
end;

Punt met X- en Y-coördinaten

 

type TPdfRectangle = record
  Left, Top, Right, Bottom: Double;
end;
type TPdfRectangles = array of TPdfRectangle;

Rechthoekgebied met Left-, Top-, Right- en Bottom-coördinaten

 

type TPdfFileIdentifierType = (fidPermanent, fidChanging);

Selector voor trailer-bestandsidentificatie. fidPermanent leest de eerste /ID-entry en fidChanging leest de tweede /ID-entry

 

type TPdfPageBox = (pbMedia, pbCrop, pbBleed, pbTrim, pbArt);

Box-selector van de paginadictionary, gebruikt door PageBox, GetPageBox en SetPageBox

 

type TPdfJavaScriptAction = record
  Name: WString;
  Script: WString;
end;
type TPdfJavaScriptActions = array of TPdfJavaScriptAction;

Actiedata uit de JavaScript-name-tree op documentniveau

 

type TPdfSignature = record
  Content: TBytes;
  Encoding: WString;
  Reason: WString;
  Time: WString;
  Permission: Integer;
end;

Informatie over digitale handtekeningen

 

type TPdfIntegerArray = array of Integer;

Integer-array gebruikt door marked-content-ID-lijsten van de structuurboom

 

type TPdfSingleArray = array of Single;

Single-precision floating-point-array gebruikt door character-positie-setters van tekstobjecten

 

type TPdfPrintPageRange = record
  StartPage: Integer;
  EndPage: Integer;
end;
type TPdfPrintPageRanges = array of TPdfPrintPageRange;

One-based afdrukpaginabereiken uit de viewer-voorkeuren van het document

 

type TPdfStructureElement = record
  Level: Integer;
  ParentIndex: Integer;
  TypeName: WString;
  ObjectType: WString;
  Title: WString;
  AlternateText: WString;
  ActualText: WString;
  Expansion: WString;
  ID: WString;
  Language: WString;
  MarkedContentID: Integer;
  MarkedContentIDs: TPdfIntegerArray;
  ChildCount: Integer;
  ChildMarkedContentIDs: TPdfIntegerArray;
  AttributeCount: Integer;
  ListNumbering: WString;
  Scope: WString;
  HasHeaders: Boolean;
  HeadersIds: array of WString;
  ColSpan: Integer;
  RowSpan: Integer;
  HasPrintField: Boolean;
  NamespaceUri: WString;
  RoleMappedNamespaceUri: WString;
  RoleMappedTypeName: WString;
  HasReference: Boolean;
  HasAssociatedFile: Boolean;
  AssociatedFileRelationship: WString;
  AssociatedFileDescription: WString;
  AnnotationSubtype: WString;
  AnnotationContents: WString;
  AnnotationAlternateText: WString;
  IsArtifact: Boolean;
  WidgetCount: Integer;
  HasAppearance: Boolean;
  LabelText: WString;
  FieldAlternateName: WString;
end;

type TPdfStructureElements = array of TPdfStructureElement;

Gevlakte data van logische structuurelementen voor tagged PDF-pagina's

 

type TPdfFormSelectionRect = record
  PageNumber: Integer;
  Bounds: TPdfRectangle;
end;

Eén rechthoek in paginacoördinaten, in eigendom van de aanroeper, gerapporteerd door native selectie van formuliertekst

 

type TPdfStructureReadOptions = record
  MaxDepth: Integer;
  MaxElements: Integer;
  MaxAttributeValues: Integer;
  DeadlineMilliseconds: Cardinal;
  IncludeAttributes: Boolean;
  class function Default: TPdfStructureReadOptions; static;
end;

Resourcebudgetten voor het iteratief doorlopen van de native structuurboom

type TPdfStructureReadStatus = record
  Completed: Boolean;
  ElementsVisited: Integer;
  AttributeValuesVisited: Integer;
  DepthLimitReached: Boolean;
  ElementLimitReached: Boolean;
  AttributeLimitReached: Boolean;
  DeadlineReached: Boolean;
  VisitorStopped: Boolean;
end;

Details over voltooiing en afkapping, geretourneerd door de methoden die de structuurboom doorlopen

 

type TPdfVersion = (pvUnknown, pv10, pv11, pv12, pv13, pv14, pv15, pv16, pv17);

De versie van een PDF-bestand of een expliciet SaveAs-doel. Mogelijke waarden: onbekende versie, PDF-versie 1.0 tot 1.7. Expliciete SaveAs-doelen van PDF 1.3 tot en met PDF 1.7 worden genormaliseerd en gevalideerd tegen de gekozen PDF-versie

 

type TPrintPaperHandling = (phUndefined, phSimplex, phDuplexFlipShortEdge, phDuplexFlipLongEdge);

Papierafruikopties voor afdrukken

 

type TPdfPrintMode = (prEmf, prTextOnly, prPostScript2, prPostScript3, prPostScript2PassThrough, prPostScript3PassThrough, prEmfImageMasks, prPostScript3Type42, prPostScript3Type42PassThrough);

Windows PDFium-printuitvoermodus, gekozen via SetPdfPrintMode

 

type TRenderOption = (reAnnotations, reLcd, reNoNativeText, reGrayscale, reDebugInfo, reNoCatchException, reLimitCache, reHalftone, rePrinting, reReverseByteOrder, reNoSmoothText, reNoSmoothImage, reNoSmoothPath, reInvert, reNightDuotone);

type TRenderOptions = set of TRenderOption;

Render-vlaggen voor pagina's

 

type TRotation = (ro0, ro90, ro180, ro270);

De rotatie van de PDF-pagina. Paginarotatie gebeurt met de klok mee

 

type TSaveOption = (saNone, saIncremental, saNoIncremental, saRemoveSecurity);

Bepaalt hoe het PDF-document wordt opgeslagen

 

type TSearchOption = (seCaseSensitive, seWholeWord, seConsecutive);

type TSearchOptions = set of TSearchOption;

Zoekvlaggen

 

type TWebLink = record
  Url: WString;
  Rectangles: TPdfRectangles;
end;

type TWebLinks = array of TWebLink;

URL-informatie en grenzen voor de weblink

 

type WString = {$ifdef D2009PLUS} string {$else} WideString {$endif D2009PLUS};

Brede string

 

Constanten

const PointsPerInch: Integer = 72;

PDF gebruikt punten met een dichtheid van 72 punten per inch

 

const FLAT_NORMALDISPLAY = 0;
const FLAT_PRINT = 1;

Afvlakprofielen doorgegeven aan FlattenPage / FlattenAllPages. FLAT_NORMALDISPLAY is gericht op schermweergave; FLAT_PRINT op gedrukte uitvoer

 

const FLATTEN_FAIL = 0;
const FLATTEN_SUCCESS = 1;
const FLATTEN_NOTHINGTODO = 2;

Resultaatcodes geretourneerd door FlattenPage

 

type TPdfReadingUnit = record
  Text: WString;
  Kind: TPdfContentFragmentKind;
  HeadingLevel: Integer;
  Page: Integer;
  Rects: TPdfRectangles;
  FragmentIndex: Integer;
  SentenceIndex: Integer;
  IsAlternateText: Boolean;
  Language: WString;
end

type TPdfReadingUnits = array of TPdfReadingUnit;

Leeseenheden op zinsniveau, gebruikt door tekst-naar-spraak en ondersteunende luister-leesworkflows

 

type TPdfWordBox = record
  Text: WString;
  StartIndex: Integer;
  Count: Integer;
  Rect: TPdfRectangle;
  Page: Integer;
end

type TPdfWordBoxes = array of TPdfWordBox;

Tekstbereiken en paginarechthoeken op woordniveau, gebruikt door gesynchroniseerde leesmarkeringen

 

type TPdfSpokenSpan = record
  SpokenStart: Integer;
  SpokenCount: Integer;
  Page: Integer;
  StartIndex: Integer;
  Count: Integer;
end

type TPdfSpokenSpans = array of TPdfSpokenSpan;

Gemapte runs die offsets van de spraakengine terugvertalen naar PDF-paginatekst

 

type TPdfSpokenText = record
  Text: WString;
  Spans: TPdfSpokenSpans;
end

type TPdfSpokenTexts = array of TPdfSpokenText;

Spraakchunks en bronmappings, gebruikt door hardop-leesworkflows en TPdfReadingSession

 

type TPdfReadingSessionState = (pssIdle, pssSpeaking, pssPaused);

Afspeelstatus gerapporteerd door TPdfReadingSession

 

Globale variabelen

var LibraryName: string = 'pdfium.dll';

Naam van de standaard PDFium-bibliotheek wanneer EnableV8Engine False is. Kan worden gewijzigd vóór het aanroepen van LoadLibrary

 

var EnableV8Engine: Boolean = False;

Zet op True vóór het laden om pdfium.v8.dll uit de bijbehorende Win32- of Win64-map DLLs te selecteren

 

Globale functies

Eigenschappen

Methoden

Gebeurtenissen