PDFText Component

Properties   Methods   Events   Config Settings   Errors  

The PDFText component provides text and media extraction capabilities for PDF documents.

Syntax

TipkPDFText

Remarks

The PDFText component automates text and image extraction from PDF documents.

Start with providing the document that you want to extract information from as a file (InputFile), byte array (InputData), or stream (SetInputStream) and calling Open. Once the document is opened, call the GetDocumentText or GetPageText methods to extract text content to a string. Use SaveMedia to extract images: pdftext.InputFile = "othello.pdf"; pdftext.Open(); string text = pdftext.GetDocumentText(); pdftext.SaveMedia(0, "picture.jpg"); pdftext.Close();

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Attachments Property (PDFText Component)

A collection of all attached files found in the document.

Syntax

property Attachments: TipkPDFAttachmentList read get_Attachments write set_Attachments;

Remarks

This property is used to access the details of all the attached files identified in the document. Use SaveAttachment to save attachments from this collection.

This property is not available at design time.

Please refer to the PDFAttachment type for a complete list of fields.

DecryptionCert Property (PDFText Component)

The decryption certificate.

Syntax

property DecryptionCert: TipkCertificate read get_DecryptionCert write set_DecryptionCert;

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

InputData Property (PDFText Component)

A byte array containing the PDF document to process.

Syntax

property InputData: TBytes read get_InputData write set_InputData;

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

This property is not available at design time.

InputFile Property (PDFText Component)

The PDF file to process.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

Default Value

''

Remarks

This property is used to provide a path to the PDF document to be processed.

Media Property (PDFText Component)

A collection of all media objects found in the document.

Syntax

property Media: TipkPDFMediaList read get_Media write set_Media;

Remarks

This property is used to access the details of all the media objects identified in the document. The only media type that is currently supported is bitmap (a fixed-size image).

Use SaveMedia to extract the embedded media object to a local file.

This property is not available at design time.

Please refer to the PDFMedia type for a complete list of fields.

Password Property (PDFText Component)

The password to decrypt the document with.

Syntax

property Password: String read get_Password write set_Password;

Default Value

''

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

PDFAConformanceLevel Property (PDFText Component)

The PDF/A conformance level of the document.

Syntax

property PDFAConformanceLevel: TipkPDFAConformanceLevels read get_PDFAConformanceLevel write set_PDFAConformanceLevel;

TipkPDFAConformanceLevels = (
  paclNone,
                  paclA1a,
                  paclA1b,
                  paclA2a,
                  paclA2b,
                  paclA2u,
                  paclA3a,
                  paclA3b,
                  paclA3u,
                  paclA4,
                  paclA4e,
                  paclA4f
                );

Default Value

paclNone

Remarks

This property is used to specify the desired PDF/A conformance level the component attempts to apply when operating on the document.

Possible values are:

Close Method (PDFText Component)

Closes the opened document.

Syntax

procedure Close();

Remarks

This method is used to close the previously opened document. It should always be preceded by a call to Open.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close();

Config Method (PDFText Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Encrypted Method (PDFText Component)

Checks whether the document is encrypted.

Syntax

function Encrypted(): Boolean;

Remarks

This method is used to determine whether the document is encrypted. It returns False if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

GetDocumentProperty Method (PDFText Component)

Returns the value of a document property.

Syntax

function GetDocumentProperty(DocumentProperty: String): String;

Remarks

This method is used to obtain the value of a document property. The list of settings below may be extended in the future.

DocumentProperty specifies the document property to read. Possible values are:

Example: pdftext.InputFile = "input.pdf"; pdftext.Open(); string description = pdftext.GetDocumentProperty("Xmp[dc:description]"); string metadataXml = pdftext.GetDocumentProperty("Xmp"); // Use language descriptors for multi-language properties string descriptionEs = pdftext.GetDocumentProperty("Xmp[dc:description[es]]"); pdftext.Close(); NOTE: Each document property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

GetDocumentText Method (PDFText Component)

Returns the entire text content contained in the document.

Syntax

function GetDocumentText(): String;

Remarks

This method is used to obtain the whole body of text from the opened document.

GetPageProperty Method (PDFText Component)

Returns the value of a page property.

Syntax

function GetPageProperty(PageIndex: Integer; PageProperty: String): String;

Remarks

This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details.

PageIndex specifies the page to read information about (with a valid range from 0 to PageCount - 1), and PageProperty specifies the page property to read. Possible values are:

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); NOTE: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

GetPageText Method (PDFText Component)

Returns the text content residing on a specific page.

Syntax

function GetPageText(PageIndex: Integer): String;

Remarks

This method is used to obtain a part of the document text residing on the page specified by PageIndex (zero-based).

Open Method (PDFText Component)

Opens the document for processing.

Syntax

procedure Open();

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as extracting, editing, or replacing text. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

Reset Method (PDFText Component)

Resets the component.

Syntax

procedure Reset();

Remarks

This method is used to reset the component's properties and configuration settings to their default values.

SaveAttachment Method (PDFText Component)

Saves a PDF attachment to a file.

Syntax

procedure SaveAttachment(Index: Integer; FileName: String);

Remarks

This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the Attachments collection.

Index is the index of the attachment in the Attachments collection to be saved.

FileName specifies the filename that the attachment will be saved to.

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); Example (saving to a stream): component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream property if it's set NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

SaveMedia Method (PDFText Component)

Saves a media object to a file.

Syntax

procedure SaveMedia(Index: Integer; FileName: String);

Remarks

This method is used to retrieve the contents of a media object from the document and save it to a file. It does not modify the contents of the Media collection.

Index is the index of the media object in the Media collection to be saved.

FileName specifies the filename that the media object will be saved to.

Example: pdftext.InputFile = "input_with_pictures.pdf"; pdftext.Open(); pdftext.SaveMedia(0, "picture.jpg"); pdftext.Close(); Example (saving to a stream): pdftext.InputFile = "input_with_pictures.pdf"; pdftext.Open(); pdftext.Media[0].OutputStream = myStream; pdftext.SaveMedia(0, null); // null means use the OutputStream property if it's set pdftext.Close();

SetInputStream Method (PDFText Component)

Sets the stream containing the PDF document to process.

Syntax

procedure SetInputStream(InputStream: TStream);

Remarks

This method is used to set the stream from which the component reads the PDF document to be processed. If an input stream is set before the component attempts to perform operations on the document, the component reads the data from the input stream instead of from the InputFile or InputData properties.

NOTE: It may be useful to additionally set CloseInputStreamAfterProcessing to True when using input streams.

DocumentInfo Event (PDFText Component)

Fired when the document has been loaded into memory.

Syntax

type TDocumentInfoEvent = procedure (
  Sender: TObject;
  PageCount: Integer
) of Object;

property OnDocumentInfo: TDocumentInfoEvent read FOnDocumentInfo write FOnDocumentInfo;

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details.

PageCount reports the number of pages in the document.

This event is fired when Open is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFText Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (PDFText Component)

Fired once for each log message.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel configuration setting.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFText Component)

Fired when the component detects that the document is encrypted with a password.

Syntax

type TPasswordEvent = procedure (
  Sender: TObject;
  Available: Boolean;
  var Cancel: Boolean
) of Object;

property OnPassword: TPasswordEvent read FOnPassword write FOnPassword;

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to Password.

Available indicates whether the decryption password is already available to the component or still needs to be set. If this parameter is False, the correct password must be provided for the decryption attempt to succeed.

Cancel determines whether the component will stop firing this event to request a password.

RecipientInfo Event (PDFText Component)

Fired for each recipient certificate of the encrypted document.

Syntax

type TRecipientInfoEvent = procedure (
  Sender: TObject;
  const Issuer: String;
  const SerialNumber: String;
  const SubjectKeyIdentifier: String;
  Available: Boolean;
  var Cancel: Boolean
) of Object;

property OnRecipientInfo: TRecipientInfoEvent read FOnRecipientInfo write FOnRecipientInfo;

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to DecryptionCert.

Issuer specifies the subject of the issuer certificate.

SerialNumber specifies the serial number of the encryption certificate.

SubjectKeyIdentifier specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

Available indicates whether the decryption certificate is already available to the component or still needs to be set. If this parameter is False, the correct certificate must be provided for the decryption attempt to succeed.

Cancel determines whether the component will stop firing this event to request a certificate.

NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate causes its own invocation of this event.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• Encoded
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• Subject
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version

Fields

Constructors

constructor Create();

constructor Create(valEncoded: TBytes);

constructor Create(valStoreType: TipkCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

constructor Create(valStoreType: TipkCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

PDFAttachment Type

The file being attached to the PDF document.

Remarks

This type contains information about the file that is being attached to the document.

• AFRelationship
• AttachmentType
• ContentType
• CreationDate
• Data
• Description
• FileName
• InputStream
• ModificationDate
• Name
• OutputStream
• Size

Fields

Constructors

constructor Create();

constructor Create(valFileName: String);

constructor Create(valFileName: String; valDescription: String);

constructor Create(valFileName: String; valDescription: String; valAttachmentType: Integer);

constructor Create(valData: TBytes; valName: String; valDescription: String);

constructor Create(valData: TBytes; valName: String; valDescription: String; valAttachmentType: Integer);

PDFMedia Type

The media object that is included as part of the PDF document.

Remarks

This type contains information about the media object (such as an image) that is included in the document.

• ContentType
• Data
• Height
• InputStream
• OutputStream
• Size
• Width

Fields

Constructors

constructor Create();

constructor Create(valData: TBytes);

Config Settings (PDFText Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PDFText Config Settings

Base Config Settings

Trappable Errors (PDFText Component)

PDF Errors

Parsing Errors