# PDFText Class

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

## Syntax

```text
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](#inputfile-property-pdftext-class)), byte array ([InputData](#inputdata-property-pdftext-class)), or stream ([SetInputStream](#setinputstream-method-pdftext-class)) and calling [Open](#open-method-pdftext-class). Once the document is opened, call the [GetDocumentText](#getdocumenttext-method-pdftext-class) or [GetPageText](#getpagetext-method-pdftext-class) methods to extract text content to a string. Use [SaveMedia](#savemedia-method-pdftext-class) to extract images:

```csharp
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.*

|  |  |
| --- | --- |
| [Attachments](#attachments-property-pdftext-class) | A collection of all attached files found in the document. |
| [DecryptionCert](#decryptioncert-property-pdftext-class) | The decryption certificate. |
| [InputData](#inputdata-property-pdftext-class) | A byte array containing the PDF document to process. |
| [InputFile](#inputfile-property-pdftext-class) | The PDF file to process. |
| [Media](#media-property-pdftext-class) | A collection of all media objects found in the document. |
| [Password](#password-property-pdftext-class) | The password to decrypt the document with. |

## Method List

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

|  |  |
| --- | --- |
| [Close](#close-method-pdftext-class) | Closes the opened document. |
| [Config](#config-method-pdftext-class) | Sets or retrieves a configuration setting. |
| [Encrypted](#encrypted-method-pdftext-class) | Checks whether the document is encrypted. |
| [GetDocumentProperty](#getdocumentproperty-method-pdftext-class) | Returns the value of a document property. |
| [GetDocumentText](#getdocumenttext-method-pdftext-class) | Returns the entire text content contained in the document. |
| [GetPageProperty](#getpageproperty-method-pdftext-class) | Returns the value of a page property. |
| [GetPageText](#getpagetext-method-pdftext-class) | Returns the text content residing on a specific page. |
| [Open](#open-method-pdftext-class) | Opens the document for processing. |
| [Reset](#reset-method-pdftext-class) | Resets the class. |
| [SaveAttachment](#saveattachment-method-pdftext-class) | Saves a PDF attachment to a file. |
| [SaveMedia](#savemedia-method-pdftext-class) | Saves a media object to a file. |
| [SetInputStream](#setinputstream-method-pdftext-class) | Sets the stream containing the PDF document to process. |

## 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.*

|  |  |
| --- | --- |
| [DocumentInfo](#documentinfo-event-pdftext-class) | Fired when the document has been loaded into memory. |
| [Error](#error-event-pdftext-class) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-pdftext-class) | Fired once for each log message. |
| [Password](#password-event-pdftext-class) | Fired when the class detects that the document is encrypted with a password. |
| [RecipientInfo](#recipientinfo-event-pdftext-class) | Fired for each recipient certificate of the encrypted document. |

## Config Settings

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

|  |  |
| --- | --- |
| [AFRelationship\[Key\]](#AFRelationship[Key]) | The value of the AFRelationship key for the attachment. |
| [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether to close the input stream after processing. |
| [LoadMedia](#LoadMedia) | Whether to load images from the document. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [OwnerPassword](#OwnerPassword) | The owner password to decrypt the document with. |
| [TempPath](#TempPath) | The location where temporary files are stored. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |
| [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. |

# Attachments Property ([PDFText](#pdftext-class) Class)

A collection of all attached files found in the document.

## Syntax

```text
public PDFAttachmentList getAttachments();
```

## Remarks

This property is used to access the details of all the attached files identified in the document. Use [SaveAttachment](#saveattachment-method-pdftext-class) to save attachments from this collection.

This property is not available at design time.

 Please refer to the [PDFAttachment](#pdfattachment-type) type for a complete list of fields.

# DecryptionCert Property ([PDFText](#pdftext-class) Class)

The decryption certificate.

## Syntax

```text
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](#certificate-type) type for a complete list of fields.

# InputData Property ([PDFText](#pdftext-class) Class)

A byte array containing the PDF document to process.

## Syntax

```text
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](#pdftext-class) Class)

The PDF file to process.

## Syntax

```text
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](#pdftext-class) Class)

A collection of all media objects found in the document.

## Syntax

```text
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 [SaveMedia](#savemedia-method-pdftext-class) to extract the embedded media object to a local file.

This property is not available at design time.

 Please refer to the [PDFMedia](#pdfmedia-type) type for a complete list of fields.

# Password Property ([PDFText](#pdftext-class) Class)

The password to decrypt the document with.

## Syntax

```text
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](#OwnerPassword), most implementations use the same value for both.

# Close Method ([PDFText](#pdftext-class) Class)

Closes the opened document.

## Syntax

```text
public void close();
```

## Remarks

This method is used to close the previously opened document. It should always be preceded by a call to [Open](#open-method-pdftext-class).

**Example:**

```csharp
component.InputFile = "input.pdf";
component.Open();
// Some operation
component.Close();
```

# Config Method ([PDFText](#pdftext-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pdftext-class) 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](#config-settings-pdftext-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Encrypted Method ([PDFText](#pdftext-class) Class)

Checks whether the document is encrypted.

## Syntax

```text
public boolean encrypted();
```

## 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:**

```csharp
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](#pdftext-class) Class)

Returns the value of a document property.

## Syntax

```text
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:

| Document property | Default value | Description |
| --- | --- | --- |
| Xmp | "" | The XML body of the XMP metadata embedded in the document. |
| Xmp[property] | "" | The value of an XMP metadata property. |
| XmpStream | "" | The hex-encoded content of the XMP metadata stream. |

**Example:**

```csharp
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](#documentinfo-event-pdftext-class) event.

# GetDocumentText Method ([PDFText](#pdftext-class) Class)

Returns the entire text content contained in the document.

## Syntax

```text
public String getDocumentText();
```

## Remarks

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

# GetPageProperty Method ([PDFText](#pdftext-class) Class)

Returns the value of a page property.

## Syntax

```text
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:

| Page property | Default value | Description |
| --- | --- | --- |
| CropLowerLeftX | 0 | The lower-left X coordinate of the page crop area in points. |
| CropLowerLeftY | 0 | The lower-left Y coordinate of the page crop area in points. |
| CropUpperRightX | 0 | The upper-right X coordinate of the page crop area in points. |
| CropUpperRightY | 0 | The upper-right Y coordinate of the page crop area in points. |
| Height | 0 | The height of the page in points. |
| MediaLowerLeftX | 0 | The lower-left X coordinate of the page media area in points. |
| MediaLowerLeftY | 0 | The lower-left Y coordinate of the page media area in points. |
| MediaUpperRightX | 0 | The upper-right X coordinate of the page media area in points. |
| MediaUpperRightY | 0 | The upper-right Y coordinate of the page media area in points. |
| Rotation | 0 | The rotation angle of the page in degrees clockwise. Supported values: 0, 90, 180, 270. |
| Width | 0 | The width of the page in points. |

**Example:**

```csharp
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:

```csharp
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](#documentinfo-event-pdftext-class) event.

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

# GetPageText Method ([PDFText](#pdftext-class) Class)

Returns the text content residing on a specific page.

## Syntax

```text
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](#pdftext-class) Class)

Opens the document for processing.

## Syntax

```text
public void open();
```

## Remarks

This method is used to open the document specified in [InputFile](#inputfile-property-pdftext-class), [InputData](#inputdata-property-pdftext-class), or [SetInputStream](#setinputstream-method-pdftext-class) before performing some operation on it, such as extracting, editing, or replacing text. When finished, call [Close](#close-method-pdftext-class) to complete or discard the operation.

It is recommended to use this method (alongside [Close](#close-method-pdftext-class)) when performing multiple operations on the document at once.

# Reset Method ([PDFText](#pdftext-class) Class)

Resets the class.

## Syntax

```text
public void reset();
```

## Remarks

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

# SaveAttachment Method ([PDFText](#pdftext-class) Class)

Saves a PDF attachment to a file.

## Syntax

```text
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](#attachments-property-pdftext-class) collection.

*Index* is the index of the attachment in the [Attachments](#attachments-property-pdftext-class) collection to be saved.

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

**Example:**

```csharp
component.InputFile = "input_with_attachment.pdf";
component.Open();
component.SaveAttachment(0, "a.dat");
component.Close();
```

 **Example (saving to a stream):**

```csharp
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 opens it, performs the operation, then closes it.

# SaveMedia Method ([PDFText](#pdftext-class) Class)

Saves a media object to a file.

## Syntax

```text
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](#media-property-pdftext-class) collection.

*Index* is the index of the media object in the [Media](#media-property-pdftext-class) collection to be saved.

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

**Example:**

```csharp
pdftext.InputFile = "input_with_pictures.pdf";
pdftext.Open();
pdftext.SaveMedia(0, "picture.jpg");
pdftext.Close();
```

 **Example (saving to a stream):**

```csharp
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](#pdftext-class) Class)

Sets the stream containing the PDF document to process.

## Syntax

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

## Remarks

This method is used to set the stream from which the class reads the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class reads the data from the input stream instead of from the [InputFile](#inputfile-property-pdftext-class) or [InputData](#inputdata-property-pdftext-class) properties.

NOTE: It may be useful to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) to *true* when using input streams.

# DocumentInfo Event ([PDFText](#pdftext-class) Class)

Fired when the document has been loaded into memory.

## Syntax

```text
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 [Open](#open-method-pdftext-class) is called, but only after [Password](#password-event-pdftext-class) or [RecipientInfo](#recipientinfo-event-pdftext-class) is fired (if applicable) and the document has been decrypted.

# Error Event ([PDFText](#pdftext-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
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](#trappable-errors-pdftext-class) section.

# Log Event ([PDFText](#pdftext-class) Class)

Fired once for each log message.

## Syntax

```text
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](#LogLevel) configuration setting.

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

|  |  |
| --- | --- |
| 0 (None) | No messages are logged. |
| 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. |
| 2 (Verbose) | Detailed data such as HTTP requests are logged. |
| 3 (Debug) | Debug data including the full chain validation procedure are logged. |

*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](#pdftext-class) Class)

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

## Syntax

```text
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 [Password](#password-property-pdftext-class).

*Available* indicates whether the decryption password is already available to the class 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 class will stop firing this event to request a password.

# RecipientInfo Event ([PDFText](#pdftext-class) Class)

Fired for each recipient certificate of the encrypted document.

## Syntax

```text
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 [DecryptionCert](#decryptioncert-property-pdftext-class).

*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 *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 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.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *String (read-only)*
*Default Value: ""*

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

 **ExpirationDate** *String (read-only)*
*Default Value: ""*

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *String (read-only)*
*Default Value: ""*

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **Fingerprint** *String (read-only)*
*Default Value: ""*

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

 **FingerprintSHA1** *String (read-only)*
*Default Value: ""*

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

 **FingerprintSHA256** *String (read-only)*
*Default Value: ""*

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

 **Issuer** *String (read-only)*
*Default Value: ""*

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

 **KeyPassword** *String*
*Default Value: ""*

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys.

NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey).

 **PrivateKey** *String (read-only)*
*Default Value: ""*

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *String (read-only)*
*Default Value: ""*

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *String (read-only)*
*Default Value: ""*

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **PublicKeyAlgorithm** *String (read-only)*
*Default Value: ""*

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

 **PublicKeyLength** *int (read-only)*
*Default Value: 0*

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **SerialNumber** *String (read-only)*
*Default Value: ""*

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

 **SignatureAlgorithm** *String (read-only)*
*Default Value: ""*

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

 **Store** *String*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StoreB** *byte[]*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StorePassword** *String*
*Default Value: ""*

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

 **StoreType** *int*
*Default Value: 0*

The type of certificate store for this certificate.

 The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This field can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *String (read-only)*
*Default Value: ""*

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *String (read-only)*
*Default Value: ""*

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA1** *String (read-only)*
*Default Value: ""*

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA256** *String (read-only)*
*Default Value: ""*

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **Usage** *String (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_UsageFlags).

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

 **UsageFlags** *int (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

This functionality currently is not available when the provider is OpenSSL.

 **Version** *String (read-only)*
*Default Value: ""*

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **Subject** *String*
*Default Value: ""*

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

If a field value contains a comma, it must be quoted.

 **Encoded** *String*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

 **EncodedB** *byte[]*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

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

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

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

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

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

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

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

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

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

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

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

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# 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.

The following fields are available:

- [ContentType](#PDFAttachment_f_ContentType)

- [CreationDate](#PDFAttachment_f_CreationDate)

- [Data](#PDFAttachment_f_Data)

- [Description](#PDFAttachment_f_Description)

- [FileName](#PDFAttachment_f_FileName)

- [InputStream](#PDFAttachment_f_InputStream)

- [ModificationDate](#PDFAttachment_f_ModificationDate)

- [Name](#PDFAttachment_f_Name)

- [OutputStream](#PDFAttachment_f_OutputStream)

- [Size](#PDFAttachment_f_Size)

## Fields

 **ContentType** *String*
*Default Value: ""*

The content type of the attachment.

 **CreationDate** *String*
*Default Value: ""*

The creation date of the attachment.

 **Data** *String*
*Default Value: ""*

The raw data of the attachment.

If [OutputStream](#PDFAttachment_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveAttachment.

 **DataB** *byte[]*
*Default Value: ""*

The raw data of the attachment.

If [OutputStream](#PDFAttachment_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveAttachment.

 **Description** *String*
*Default Value: ""*

A textual description of the attachment.

 **FileName** *String*
*Default Value: ""*

The path and filename of the attachment.

 **InputStream** *java.io.InputStream*
*Default Value: ""*

A stream containing the attachment.

If this field is set to a valid stream, the class attaches the data from the stream as the current attachment.

 **ModificationDate** *String*
*Default Value: ""*

The date and time of the file's last modification.

 **Name** *String*
*Default Value: ""*

The name of the attachment.

 **OutputStream** *java.io.OutputStream*
*Default Value: ""*

The stream to write the attachment to.

If this field is set to a valid stream, the class writes to the stream when an empty string is passed to SaveAttachment.

 **Size** *long (read-only)*
*Default Value: 0*

The attachment's size in bytes.

## Constructors

```text
public PDFAttachment();
```

```text
public PDFAttachment(String fileName);
```

```text
public PDFAttachment(String fileName, String description);
```

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

```text
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.

The following fields are available:

- [ContentType](#PDFMedia_f_ContentType)

- [Data](#PDFMedia_f_Data)

- [Height](#PDFMedia_f_Height)

- [InputStream](#PDFMedia_f_InputStream)

- [OutputStream](#PDFMedia_f_OutputStream)

- [Size](#PDFMedia_f_Size)

- [Width](#PDFMedia_f_Width)

## Fields

 **ContentType** *String (read-only)*
*Default Value: ""*

The content type of the media object.

 **Data** *String*
*Default Value: ""*

The raw data of the media object.

If [OutputStream](#PDFMedia_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveMedia.

 **DataB** *byte[]*
*Default Value: ""*

The raw data of the media object.

If [OutputStream](#PDFMedia_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveMedia.

 **Height** *int (read-only)*
*Default Value: 0*

The height of the media object in pixels (i.e., its vertical resolution).

 **InputStream** *java.io.InputStream*
*Default Value: ""*

A stream containing the media object.

If this field is set to a valid stream, the class adds the data from the stream as the current image.

 **OutputStream** *java.io.OutputStream*
*Default Value: ""*

The stream to write the image data to.

If this field is set to a valid stream, the class writes to the stream when an empty string is passed to SaveMedia.

 **Size** *long (read-only)*
*Default Value: 0*

The size of the media in bytes.

 **Width** *int (read-only)*
*Default Value: 0*

The width of the media object in pixels (i.e., its horizontal resolution).

## Constructors

```text
public PDFMedia();
```

```text
public PDFMedia(byte[] data);
```

```text
public PDFMedia(java.io.InputStream inputStream);
```

# Config Settings ([PDFText](#pdftext-class) 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](#config-method-pdftext-class) method.

### PDFText Config Settings

**AFRelationship[Key]**: The value of the AFRelationship key for the attachment.This setting specifies the value of the AFRelationship key for the attachment. This key in the file specification dictionary expresses the relationship between the attachment and the document, and it must be set for each attachment added to PDF/A-3 documents. *Key* is either the index of the attachment in the [Attachments](#attachments-property-pdftext-class) collection or the [Name](#PDFAttachment_f_Name) of the attachment.

**CloseInputStreamAfterProcessing**: Whether to close the input stream after processing.This setting determines whether the input stream specified in [SetInputStream](#setinputstream-method-pdftext-class) will be closed after processing is complete. The default value is *true*.

**LoadMedia**: Whether to load images from the document.This setting specifies whether the class loads images from the document. If media does not need to be accessed, it can be set to *false* to speed up document processing. The default value is *true*.

**LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-pdftext-class) event. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No messages are logged. |
| 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. |
| 2 (Verbose) | Detailed data such as HTTP requests are logged. |
| 3 (Debug) | Debug data including the full chain validation procedure are logged. |

**OwnerPassword**: The owner password to decrypt the document with.This setting is used to provide the document owner password for decryption. Though it may be different from [Password](#password-property-pdftext-class), most implementations use the same value for both.

**TempPath**: The location where temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. It can be useful to reduce memory usage.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

**UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*.

# Trappable Errors ([PDFText](#pdftext-class) Class)

### PDF Errors

|  |  |
| --- | --- |
| 804 | PDF decompression failed. |
| 805 | Cannot add entry to cross-reference table. |
| 806 | Unsupported field size. |
| 807 | Unsupported Encoding filter. |
| 808 | Unsupported predictor algorithm. |
| 809 | Unsupported document version. |
| 812 | Cannot read PDF file stream. |
| 813 | Cannot write to PDF file stream. |
| 814 | OutputFile already exists and Overwrite is false. |
| 815 | Invalid parameter. |
| 817 | Bad cross-reference entry. |
| 818 | Invalid object or generation number. |
| 819 | Invalid object stream. |
| 820 | Invalid stream dictionary. |
| 821 | Invalid AcroForm entry. |
| 822 | Invalid Root entry. |
| 823 | Invalid annotation. |
| 824 | The input document is empty. |
| 826 | OpenType font error. The error description contains the detailed message. |
| 828 | Invalid CMS data. The error description contains the detailed message. |
| 835 | Cannot change decryption mode for opened document. |
| 836 | Unsupported Date string. |
| 838 | Cryptographic error. The error description contains the detailed message. |
| 840 | [DecryptionCert](#decryptioncert-property-pdftext-class) error. The error description contains the detailed message. |
| 841 | Encryption failed. The error description contains the detailed message. |
| 842 | No proper certificate for encryption found. |
| 846 | Unsupported revision. |
| 847 | Unsupported security handler SubFilter. |
| 848 | Failed to verify permissions. |
| 849 | Invalid password. |
| 850 | Invalid password information. |
| 852 | Unsupported encryption algorithm. |
| 859 | Cannot encrypt encrypted document. |
| 864 | Cannot modify document after signature update. |
| 868 | Cannot encrypt or decrypt object. |
| 869 | Invalid security handler information. |
| 870 | Invalid encrypted data. |
| 871 | Invalid block cipher padding. |
| 872 | Failed to reload signature. |
| 873 | Object is not encrypted. |
| 874 | Unexpected cipher information. |
| 877 | Invalid document. Bad document catalog. |
| 878 | Invalid document Id. |
| 880 | Invalid document. Invalid requirements dictionary. |
| 881 | Invalid linearization dictionary. |
| 882 | Invalid signature information. |
| 883 | Unsupported document format. |
| 890 | Unsupported feature. |
| 891 | Internal error. The error description contains the detailed message. |
| 892 | Unsupported color. |
| 893 | This operation is not supported for this PDF/A level. |
| 894 | Interactive features ([Action](#PDFField_f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [Action](#PDFField_f_Action) property of the field. |
| 895 | Font file not found. |

### Parsing Errors

|  |  |
| --- | --- |
| 1001 | Bad object. |
| 1002 | Bad document trailer. |
| 1003 | Illegal stream dictionary. |
| 1004 | Illegal string. |
| 1005 | Indirect object expected. |
| 1007 | Invalid reference. |
| 1008 | Invalid reference table. |
| 1009 | Invalid stream data. |
| 1010 | Unexpected character. |
| 1011 | Unexpected EOF. |
| 1012 | Unexpected indirect object in cross-reference table. |
| 1013 | RDF object not found. |
| 1014 | Invalid RDF object. |
| 1015 | Cannot create element with unknown prefix. |
| 1021 | Invalid type in Root object list. |