PDFText Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

pdfsdk.PDFText

Remarks

The PDFText class 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 the Open method. 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 class with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

Attachments Property (PDFText Class)

A collection of all attached files found in the document.

Syntax

public PDFAttachmentList getAttachments();

Remarks

This property is used to access the details of all the attached files identified in the document. Use the SaveAttachment method 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 Class)

The decryption certificate.

Syntax

public Certificate getDecryptionCert();
public void setDecryptionCert(Certificate 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 Class)

A byte array containing the PDF document to process.

Syntax

public byte[] getInputData();
public void setInputData(byte[] 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 Class)

The PDF file to process.

Syntax

public String getInputFile();
public void setInputFile(String inputFile);

Default Value

""

Remarks

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

Media Property (PDFText Class)

A collection of all media objects found in the document.

Syntax

public PDFMediaList getMedia();

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 the SaveMedia method 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 Class)

The password to decrypt the document with.

Syntax

public String getPassword();
public void setPassword(String 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.

Close Method (PDFText Class)

Closes the opened document.

Syntax

public void close();

Remarks

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

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

Config Method (PDFText Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 Class)

Checks whether the document is encrypted.

Syntax

public boolean encrypted();

Remarks

This method is used to determine whether or not the document is encrypted. It will return 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 will open it, perform the operation, then close it.

GetDocumentProperty Method (PDFText Class)

Returns the value of a document property.

Syntax

public String getDocumentProperty(String documentProperty);

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

Returns the entire text content contained in the document.

Syntax

public String getDocumentText();

Remarks

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

GetPageProperty Method (PDFText Class)

Returns the value of a page property.

Syntax

public String getPageProperty(int pageIndex, String pageProperty);

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 will open it, perform the operation, then close it.

GetPageText Method (PDFText Class)

Returns the text content residing on a specific page.

Syntax

public String getPageText(int pageIndex);

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

Opens the document for processing.

Syntax

public void 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 Class)

Resets the class.

Syntax

public void reset();

Remarks

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

SaveAttachment Method (PDFText Class)

Saves a PDF attachment to a file.

Syntax

public void saveAttachment(int index, String fileName);

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 field if it's set NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

SaveMedia Method (PDFText Class)

Saves a media object to a file.

Syntax

public void saveMedia(int index, String fileName);

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 field if it's set pdftext.Close();

SetInputStream Method (PDFText Class)

Sets the stream containing the PDF document to process.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

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

NOTE: It may be useful to additionally set the CloseInputStreamAfterProcessing configuration setting to true when using input streams.

DocumentInfo Event (PDFText Class)

Fired when the document has been loaded into memory.

Syntax

public class DefaultPDFTextEventListener implements PDFTextEventListener {
  ...
  public void documentInfo(PDFTextDocumentInfoEvent e) {}
  ...
}

public class PDFTextDocumentInfoEvent {
  public int pageCount;
}

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 the Open method is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFText Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultPDFTextEventListener implements PDFTextEventListener {
  ...
  public void error(PDFTextErrorEvent e) {}
  ...
}

public class PDFTextErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws 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 Class)

Fired once for each log message.

Syntax

public class DefaultPDFTextEventListener implements PDFTextEventListener {
  ...
  public void log(PDFTextLogEvent e) {}
  ...
}

public class PDFTextLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

This event is fired once for each log message generated by the class. 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 Class)

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

Syntax

public class DefaultPDFTextEventListener implements PDFTextEventListener {
  ...
  public void password(PDFTextPasswordEvent e) {}
  ...
}

public class PDFTextPasswordEvent {
  public boolean available;
  public boolean cancel; //read-write
}

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 the Password property.

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

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

RecipientInfo Event (PDFText Class)

Fired for each recipient certificate of the encrypted document.

Syntax

public class DefaultPDFTextEventListener implements PDFTextEventListener {
  ...
  public void recipientInfo(PDFTextRecipientInfoEvent e) {}
  ...
}

public class PDFTextRecipientInfoEvent {
  public String issuer;
  public String serialNumber;
  public String subjectKeyIdentifier;
  public boolean available;
  public boolean cancel; //read-write
}

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 the DecryptionCert property.

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 class or still needs to be set. If this parameter is set to false, the correct certificate must be provided for the decryption attempt to succeed.

Cancel determines whether the class 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 will cause 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
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• KeyPassword
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

public Certificate();

public Certificate(String certificateFile);

public Certificate(byte[] encoded);

public Certificate(int storeType, String store, String storePassword, String subject);

public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);

public Certificate(int storeType, String store, String storePassword, byte[] encoded);

public Certificate(int storeType, byte[] store, String storePassword, String subject);

public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);

public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);

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.

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

Fields

Constructors

public PDFAttachment();

public PDFAttachment(String fileName);

public PDFAttachment(String fileName, String description);

public PDFAttachment(byte[] data, String name, String description);

public PDFAttachment(java.io.InputStream inputStream, String name, String description);

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

public PDFMedia();

public PDFMedia(byte[] data);

public PDFMedia(java.io.InputStream inputStream);

Config Settings (PDFText Class)

The class 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 class, access to these internal properties is provided through the Config method.

PDFText Config Settings

Base Config Settings

Trappable Errors (PDFText Class)

PDF Errors

Parsing Errors