PDFium Delphi Component Docs

TPdf-komponenten

Enhet: PDFium
TPdf
Använd TPdf-komponenten för att öppna, navigera, extrahera text och redigera PDF-dokument

Exempel

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

Typer

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;

Bokmärkesdata

 

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 för namngivna destinationer

 

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

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

Visningsläge för destinationen och dess ordnade nativa parametrar

 

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;

Data för länkannoteringar

 

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

type TPdfPermissions = set of TPdfPermission;

Typiserade dokumentbehörighetsflaggor avkodade från den nativa behörighetsmasken

 

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

En ögonblicksbild av standardfälten i dokumentets Info-ordlista

 

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

Avgör typen av PDF-objektet

 

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

Avgör hur PDF-dokumentet ska visas när det öppnas

 

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

Avgör typen av en åtgärd som är kopplad till ett bokmärke

 

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;

Data för annoteringar

 

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

type TPdfAnnotationFlags = set of TPdfAnnotationFlag;

Flaggor för annoteringar

 

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

Annoteringens undertyp

 

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

Avgör hur lager blandas in i varandra

 

type TPdfDisplayMode = (dmSingleContinuous, dmTwoPageContinuous, dmTwoPageContinuousWithCover);

Avgör hur sidorna i PDF-dokumentet visas

 

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

Funktion i PDF-dokumentet som rapporteras av händelsen OnUnsupportedFeature

 

type TPdfFillMode = (fmNone, fmAlternate, fmWinding);

Avgör hur fyllnadsytor formas när banan korsar sig själv

 

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

type TPdfFormFieldFlags = set of TPdfFormFieldFlag;

Flaggor för formulärfält

 

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;

Information om formulärfält

 

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

Avgör typen av formulärfältet

 

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

Avgör typen av formulär i PDF-dokumentet

 

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

Storlek i pixlar samt data för PDF-bildobjektet

 

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

Den form som används i ändarna på öppna delbanor

 

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

Den form som används i hörnen på banor som streckas

 

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

Punkt med X- och Y-koordinater

 

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

Rektangelområde med koordinaterna Left, Top, Right och Bottom

 

type TPdfFileIdentifierType = (fidPermanent, fidChanging);

Väljare för trailerfilidentifierare. fidPermanent läser den första /ID-posten och fidChanging läser den andra /ID-posten

 

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

Väljare för låda i sidordboken som används av PageBox, GetPageBox och SetPageBox

 

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

Åtgärdsdata för JavaScript-namnträdet på dokumentnivå

 

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

Information om digital signatur

 

type TPdfIntegerArray = array of Integer;

Heltalsarray som används av ID-listor för märkt innehåll i strukturträdet

 

type TPdfSingleArray = array of Single;

Flyttalsarray med enkel precision som används av positionssättare för tecken i textobjekt

 

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

1-baserade intervall för utskriftssidor från dokumentets visarinställningar

 

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;

Utplattade data om logiska strukturelement för taggade PDF-sidor

 

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

En rektangel i sidrummet som ägs av anroparen och rapporteras av nativt val av formulärtext

 

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

Resursbudgeter för iterativ genomlöpning av det nativa strukturträdet

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

Detaljer om fullbordan och avkortning som returneras av metoderna för genomlöpning av strukturer

 

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

Versionen för en PDF-fil eller ett explicit SaveAs-mål. Möjliga värden är: okänd version, PDF-version 1.0 till 1.7. Explicita SaveAs-mål från PDF 1.3 till och med PDF 1.7 normaliseras och valideras mot den valda PDF-versionen

 

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

Alternativ för pappershantering vid utskrift

 

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

Utskriftsläge för PDFium i Windows som väljs av SetPdfPrintMode

 

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

type TRenderOptions = set of TRenderOption;

Renderingsflaggor för sidor

 

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

PDF-sidans rotation. Sidrotationen sker medurs

 

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

Avgör hur PDF-dokumentet sparas

 

type TSearchOption = (seCaseSensitive, seWholeWord, seConsecutive);

type TSearchOptions = set of TSearchOption;

Sökflaggor

 

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

type TWebLinks = array of TWebLink;

URL-information och gränser för webblänken

 

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

Bred sträng

 

Konstanter

const PointsPerInch: Integer = 72;

PDF använder punkter med densiteten 72 punkter per tum

 

const FLAT_NORMALDISPLAY = 0;
const FLAT_PRINT = 1;

Plattläggningsprofiler som skickas till FlattenPage / FlattenAllPages. FLAT_NORMALDISPLAY riktar sig mot skärmvisning; FLAT_PRINT riktar sig mot utskriftsutdata

 

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

Resultatkoder som returneras av 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;

Läsenheter på meningsnivå som används av text-till-tal och assisterande flöden för lyssningsläsning

 

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

type TPdfWordBoxes = array of TPdfWordBox;

Textintervall på ordnivå och sidrektanglar som används av synkroniserade läsmarkeringar

 

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

type TPdfSpokenSpans = array of TPdfSpokenSpan;

Mappade sekvenser som översätter offset från talmotorn tillbaka till PDF-sidetext

 

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

type TPdfSpokenTexts = array of TPdfSpokenText;

Upplästa avsnitt och källmappningar som används av uppläsningsflöden och TPdfReadingSession

 

type TPdfReadingSessionState = (pssIdle, pssSpeaking, pssPaused);

Uppspelningstillstånd som rapporteras av TPdfReadingSession

 

Globala variabler

var LibraryName: string = 'pdfium.dll';

Namn på det standard-PDFium-bibliotek som används när EnableV8Engine är False. Kan ändras innan LoadLibrary anropas

 

var EnableV8Engine: Boolean = False;

Sätt till True före inläsning för att välja pdfium.v8.dll från motsvarande mapp DLLs för Win32 eller Win64

 

Globala funktioner

Egenskaper

Metoder

Händelser