PDFText Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

PDFSDK_PDFText

Procedural Interface

 pdfsdk_pdftext_open();
 pdfsdk_pdftext_close($res);
 pdfsdk_pdftext_register_callback($res, $id, $function);
 pdfsdk_pdftext_get_last_error($res);
 pdfsdk_pdftext_get_last_error_code($res);
 pdfsdk_pdftext_set($res, $id, $index, $value);
 pdfsdk_pdftext_get($res, $id, $index);
 pdfsdk_pdftext_do_close($res);
 pdfsdk_pdftext_do_config($res, $configurationstring);
 pdfsdk_pdftext_do_encrypted($res);
 pdfsdk_pdftext_do_getdocumentproperty($res, $documentproperty);
 pdfsdk_pdftext_do_getdocumenttext($res);
 pdfsdk_pdftext_do_getpageproperty($res, $pageindex, $pageproperty);
 pdfsdk_pdftext_do_getpagetext($res, $pageindex);
 pdfsdk_pdftext_do_open($res);
 pdfsdk_pdftext_do_reset($res);
 pdfsdk_pdftext_do_saveattachment($res, $index, $filename);
 pdfsdk_pdftext_do_savemedia($res, $index, $filename);

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) or byte array (InputData) 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 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.

AttachmentCount Property (PDFSDK_PDFText Class)

The number of records in the Attachment arrays.

Object Oriented Interface

public function getAttachmentCount();
public function setAttachmentCount($value);

Procedural Interface

pdfsdk_pdftext_get($res, 1);
pdfsdk_pdftext_set($res, 1, $value);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentAFRelationship
• AttachmentContentType
• AttachmentCreationDate
• AttachmentData
• AttachmentDescription
• AttachmentFileName
• AttachmentModificationDate
• AttachmentName
• AttachmentSize
• AttachmentType

The array indices start at 0 and end at AttachmentCount - 1.

This property is not available at design time.

Data Type

Integer

AttachmentAFRelationship Property (PDFSDK_PDFText Class)

The value of the AFRelationship key for the attachment, for example Alternative or Source .

Object Oriented Interface

public function getAttachmentAFRelationship($attachmentindex);
public function setAttachmentAFRelationship($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 2, $attachmentindex);
pdfsdk_pdftext_set($res, 2, $value, $attachmentindex);

Default Value

''

Remarks

The value of the AFRelationship key for the attachment, for example Alternative or Source.

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.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentType Property (PDFSDK_PDFText Class)

The type of the attachment.

Object Oriented Interface

public function getAttachmentType($attachmentindex);

Procedural Interface

pdfsdk_pdftext_get($res, 3, $attachmentindex);

Possible Values

PDFTEXT_ATTACHMENTTYPE_GENERIC(0), 
PDFTEXT_ATTACHMENTTYPE_ELECTRONIC_INVOICE(1)

Default Value

0

Remarks

The type of the attachment.

Possible values are:

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only and not available at design time.

Data Type

Integer

AttachmentContentType Property (PDFSDK_PDFText Class)

The content type of the attachment.

Object Oriented Interface

public function getAttachmentContentType($attachmentindex);
public function setAttachmentContentType($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 4, $attachmentindex);
pdfsdk_pdftext_set($res, 4, $value, $attachmentindex);

Default Value

''

Remarks

The content type of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentCreationDate Property (PDFSDK_PDFText Class)

The creation date of the attachment.

Object Oriented Interface

public function getAttachmentCreationDate($attachmentindex);
public function setAttachmentCreationDate($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 5, $attachmentindex);
pdfsdk_pdftext_set($res, 5, $value, $attachmentindex);

Default Value

''

Remarks

The creation date of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentData Property (PDFSDK_PDFText Class)

The raw data of the attachment.

Object Oriented Interface

public function getAttachmentData($attachmentindex);
public function setAttachmentData($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 6, $attachmentindex);
pdfsdk_pdftext_set($res, 6, $value, $attachmentindex);

Default Value

''

Remarks

The raw data of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

Binary String

AttachmentDescription Property (PDFSDK_PDFText Class)

A textual description of the attachment.

Object Oriented Interface

public function getAttachmentDescription($attachmentindex);
public function setAttachmentDescription($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 7, $attachmentindex);
pdfsdk_pdftext_set($res, 7, $value, $attachmentindex);

Default Value

''

Remarks

A textual description of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentFileName Property (PDFSDK_PDFText Class)

The path and filename of the attachment.

Object Oriented Interface

public function getAttachmentFileName($attachmentindex);
public function setAttachmentFileName($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 8, $attachmentindex);
pdfsdk_pdftext_set($res, 8, $value, $attachmentindex);

Default Value

''

Remarks

The path and filename of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentModificationDate Property (PDFSDK_PDFText Class)

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

Object Oriented Interface

public function getAttachmentModificationDate($attachmentindex);
public function setAttachmentModificationDate($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 10, $attachmentindex);
pdfsdk_pdftext_set($res, 10, $value, $attachmentindex);

Default Value

''

Remarks

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

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (PDFSDK_PDFText Class)

The name of the attachment.

Object Oriented Interface

public function getAttachmentName($attachmentindex);
public function setAttachmentName($attachmentindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 11, $attachmentindex);
pdfsdk_pdftext_set($res, 11, $value, $attachmentindex);

Default Value

''

Remarks

The name of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentSize Property (PDFSDK_PDFText Class)

The attachment's size in bytes.

Object Oriented Interface

public function getAttachmentSize($attachmentindex);

Procedural Interface

pdfsdk_pdftext_get($res, 13, $attachmentindex);

Default Value

0

Remarks

The attachment's size in bytes.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only and not available at design time.

Data Type

Long64

DecryptionCertEffectiveDate Property (PDFSDK_PDFText Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getDecryptionCertEffectiveDate();

Procedural Interface

pdfsdk_pdftext_get($res, 14);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertExpirationDate Property (PDFSDK_PDFText Class)

The date on which the certificate expires.

Object Oriented Interface

public function getDecryptionCertExpirationDate();

Procedural Interface

pdfsdk_pdftext_get($res, 15);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertExtendedKeyUsage Property (PDFSDK_PDFText Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getDecryptionCertExtendedKeyUsage();

Procedural Interface

pdfsdk_pdftext_get($res, 16);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertFingerprint Property (PDFSDK_PDFText Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getDecryptionCertFingerprint();

Procedural Interface

pdfsdk_pdftext_get($res, 17);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertFingerprintSHA1 Property (PDFSDK_PDFText Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getDecryptionCertFingerprintSHA1();

Procedural Interface

pdfsdk_pdftext_get($res, 18);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertFingerprintSHA256 Property (PDFSDK_PDFText Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getDecryptionCertFingerprintSHA256();

Procedural Interface

pdfsdk_pdftext_get($res, 19);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertIssuer Property (PDFSDK_PDFText Class)

The issuer of the certificate.

Object Oriented Interface

public function getDecryptionCertIssuer();

Procedural Interface

pdfsdk_pdftext_get($res, 20);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPrivateKey Property (PDFSDK_PDFText Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getDecryptionCertPrivateKey();

Procedural Interface

pdfsdk_pdftext_get($res, 21);

Default Value

''

Remarks

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

NOTE: The DecryptionCertPrivateKey may be available but not exportable. In this case, DecryptionCertPrivateKey returns an empty string.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPrivateKeyAvailable Property (PDFSDK_PDFText Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getDecryptionCertPrivateKeyAvailable();

Procedural Interface

pdfsdk_pdftext_get($res, 22);

Default Value

false

Remarks

Whether a DecryptionCertPrivateKey is available for the selected certificate. If DecryptionCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only and not available at design time.

Data Type

Boolean

DecryptionCertPrivateKeyContainer Property (PDFSDK_PDFText Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getDecryptionCertPrivateKeyContainer();

Procedural Interface

pdfsdk_pdftext_get($res, 23);

Default Value

''

Remarks

The name of the DecryptionCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKey Property (PDFSDK_PDFText Class)

The public key of the certificate.

Object Oriented Interface

public function getDecryptionCertPublicKey();

Procedural Interface

pdfsdk_pdftext_get($res, 24);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKeyAlgorithm Property (PDFSDK_PDFText Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getDecryptionCertPublicKeyAlgorithm();

Procedural Interface

pdfsdk_pdftext_get($res, 25);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKeyLength Property (PDFSDK_PDFText Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getDecryptionCertPublicKeyLength();

Procedural Interface

pdfsdk_pdftext_get($res, 26);

Default Value

0

Remarks

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

This property is read-only and not available at design time.

Data Type

Integer

DecryptionCertSerialNumber Property (PDFSDK_PDFText Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getDecryptionCertSerialNumber();

Procedural Interface

pdfsdk_pdftext_get($res, 27);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertSignatureAlgorithm Property (PDFSDK_PDFText Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getDecryptionCertSignatureAlgorithm();

Procedural Interface

pdfsdk_pdftext_get($res, 28);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertStore Property (PDFSDK_PDFText Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getDecryptionCertStore();
public function setDecryptionCertStore($value);

Procedural Interface

pdfsdk_pdftext_get($res, 29);
pdfsdk_pdftext_set($res, 29, $value);

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The DecryptionCertStoreType property denotes the type of the certificate store specified by DecryptionCertStore. If the store is password-protected, specify the password in DecryptionCertStorePassword.

DecryptionCertStore is used in conjunction with the DecryptionCertSubject property to specify client certificates. If DecryptionCertStore has a value, and DecryptionCertSubject or DecryptionCertEncoded is set, a search for a certificate is initiated. Please see the DecryptionCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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

This property is not available at design time.

Data Type

Binary String

DecryptionCertStorePassword Property (PDFSDK_PDFText Class)

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

Object Oriented Interface

public function getDecryptionCertStorePassword();
public function setDecryptionCertStorePassword($value);

Procedural Interface

pdfsdk_pdftext_get($res, 30);
pdfsdk_pdftext_set($res, 30, $value);

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertStoreType Property (PDFSDK_PDFText Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getDecryptionCertStoreType();
public function setDecryptionCertStoreType($value);

Procedural Interface

pdfsdk_pdftext_get($res, 31);
pdfsdk_pdftext_set($res, 31, $value);

Possible Values

PDFTEXT_DECRYPTIONCERTSTORETYPE_USER(0), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_MACHINE(1), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PFXFILE(2), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PFXBLOB(3), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_JKSFILE(4), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_JKSBLOB(5), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PEMKEY_FILE(6), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PEMKEY_BLOB(7), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_P7BFILE(11), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_P7BBLOB(12), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PPKFILE(14), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PPKBLOB(15), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_XMLFILE(16), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_XMLBLOB(17), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_JWKFILE(18), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_JWKBLOB(19), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_SECURITY_KEY(20), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_BCFKSFILE(21), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_BCFKSBLOB(22), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_PKCS11(23), 
PDFTEXT_DECRYPTIONCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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 property can take one of the following values:

This property is not available at design time.

Data Type

Integer

DecryptionCertSubjectAltNames Property (PDFSDK_PDFText Class)

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

Object Oriented Interface

public function getDecryptionCertSubjectAltNames();

Procedural Interface

pdfsdk_pdftext_get($res, 32);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertThumbprintMD5 Property (PDFSDK_PDFText Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintMD5();

Procedural Interface

pdfsdk_pdftext_get($res, 33);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertThumbprintSHA1 Property (PDFSDK_PDFText Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintSHA1();

Procedural Interface

pdfsdk_pdftext_get($res, 34);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertThumbprintSHA256 Property (PDFSDK_PDFText Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintSHA256();

Procedural Interface

pdfsdk_pdftext_get($res, 35);

Default Value

''

Remarks

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertUsage Property (PDFSDK_PDFText Class)

The text description of UsageFlags .

Object Oriented Interface

public function getDecryptionCertUsage();

Procedural Interface

pdfsdk_pdftext_get($res, 36);

Default Value

''

Remarks

The text description of DecryptionCertUsageFlags.

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.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertUsageFlags Property (PDFSDK_PDFText Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getDecryptionCertUsageFlags();

Procedural Interface

pdfsdk_pdftext_get($res, 37);

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of DecryptionCertUsageFlags is a combination of the following flags:

Please see the DecryptionCertUsage property for a text representation of DecryptionCertUsageFlags.

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

This property is read-only and not available at design time.

Data Type

Integer

DecryptionCertVersion Property (PDFSDK_PDFText Class)

The certificate's version number.

Object Oriented Interface

public function getDecryptionCertVersion();

Procedural Interface

pdfsdk_pdftext_get($res, 38);

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

DecryptionCertSubject Property (PDFSDK_PDFText Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getDecryptionCertSubject();
public function setDecryptionCertSubject($value);

Procedural Interface

pdfsdk_pdftext_get($res, 39);
pdfsdk_pdftext_set($res, 39, $value);

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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:

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

This property is not available at design time.

Data Type

String

DecryptionCertEncoded Property (PDFSDK_PDFText Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getDecryptionCertEncoded();
public function setDecryptionCertEncoded($value);

Procedural Interface

pdfsdk_pdftext_get($res, 40);
pdfsdk_pdftext_set($res, 40, $value);

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The DecryptionCertStore and DecryptionCertSubject properties also may be used to specify a certificate.

When DecryptionCertEncoded is set, a search is initiated in the current DecryptionCertStore for the private key of the certificate. If the key is found, DecryptionCertSubject is updated to reflect the full subject of the selected certificate; otherwise, DecryptionCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

InputData Property (PDFSDK_PDFText Class)

A byte array containing the PDF document to process.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

pdfsdk_pdftext_get($res, 41);
pdfsdk_pdftext_set($res, 41, $value);

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.

Data Type

Byte Array

InputFile Property (PDFSDK_PDFText Class)

The PDF file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

pdfsdk_pdftext_get($res, 42);
pdfsdk_pdftext_set($res, 42, $value);

Default Value

''

Remarks

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

Data Type

String

MediaCount Property (PDFSDK_PDFText Class)

The number of records in the Media arrays.

Object Oriented Interface

public function getMediaCount();
public function setMediaCount($value);

Procedural Interface

pdfsdk_pdftext_get($res, 43);
pdfsdk_pdftext_set($res, 43, $value);

Default Value

0

Remarks

This property controls the size of the following arrays:

• MediaContentType
• MediaData
• MediaHeight
• MediaSize
• MediaWidth

The array indices start at 0 and end at MediaCount - 1.

This property is not available at design time.

Data Type

Integer

MediaContentType Property (PDFSDK_PDFText Class)

The content type of the media object.

Object Oriented Interface

public function getMediaContentType($mediaindex);

Procedural Interface

pdfsdk_pdftext_get($res, 44, $mediaindex);

Default Value

''

Remarks

The content type of the media object.

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

String

MediaData Property (PDFSDK_PDFText Class)

The raw data of the media object.

Object Oriented Interface

public function getMediaData($mediaindex);
public function setMediaData($mediaindex, $value);

Procedural Interface

pdfsdk_pdftext_get($res, 45, $mediaindex);
pdfsdk_pdftext_set($res, 45, $value, $mediaindex);

Default Value

''

Remarks

The raw data of the media object.

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is not available at design time.

Data Type

Binary String

MediaHeight Property (PDFSDK_PDFText Class)

The height of the media object in pixels (i.

Object Oriented Interface

public function getMediaHeight($mediaindex);

Procedural Interface

pdfsdk_pdftext_get($res, 46, $mediaindex);

Default Value

0

Remarks

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

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

Integer

MediaSize Property (PDFSDK_PDFText Class)

The size of the media in bytes.

Object Oriented Interface

public function getMediaSize($mediaindex);

Procedural Interface

pdfsdk_pdftext_get($res, 49, $mediaindex);

Default Value

0

Remarks

The size of the media in bytes.

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

Long64

MediaWidth Property (PDFSDK_PDFText Class)

The width of the media object in pixels (i.

Object Oriented Interface

public function getMediaWidth($mediaindex);

Procedural Interface

pdfsdk_pdftext_get($res, 50, $mediaindex);

Default Value

0

Remarks

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

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

Integer

Password Property (PDFSDK_PDFText Class)

The password to decrypt the document with.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

pdfsdk_pdftext_get($res, 51);
pdfsdk_pdftext_set($res, 51, $value);

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.

Data Type

String

PDFAConformanceLevel Property (PDFSDK_PDFText Class)

The PDF/A conformance level of the document.

Object Oriented Interface

public function getPDFAConformanceLevel();
public function setPDFAConformanceLevel($value);

Procedural Interface

pdfsdk_pdftext_get($res, 52);
pdfsdk_pdftext_set($res, 52, $value);

Possible Values

PDFTEXT_PDFACONFORMANCELEVEL_NONE(0), 
PDFTEXT_PDFACONFORMANCELEVEL_A1A(1), 
PDFTEXT_PDFACONFORMANCELEVEL_A1B(2), 
PDFTEXT_PDFACONFORMANCELEVEL_A2A(3), 
PDFTEXT_PDFACONFORMANCELEVEL_A2B(4), 
PDFTEXT_PDFACONFORMANCELEVEL_A2U(5), 
PDFTEXT_PDFACONFORMANCELEVEL_A3A(6), 
PDFTEXT_PDFACONFORMANCELEVEL_A3B(7), 
PDFTEXT_PDFACONFORMANCELEVEL_A3U(8), 
PDFTEXT_PDFACONFORMANCELEVEL_A4(9), 
PDFTEXT_PDFACONFORMANCELEVEL_A4E(10), 
PDFTEXT_PDFACONFORMANCELEVEL_A4F(11)

Default Value

0

Remarks

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

Possible values are:

Data Type

Integer

Close Method (PDFSDK_PDFText Class)

Closes the opened document.

Object Oriented Interface

public function doClose();

Procedural Interface

pdfsdk_pdftext_do_close($res);

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

pdfsdk_pdftext_do_config($res, $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 (PDFSDK_PDFText Class)

Checks whether the document is encrypted.

Object Oriented Interface

public function doEncrypted();

Procedural Interface

pdfsdk_pdftext_do_encrypted($res);

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

Returns the value of a document property.

Object Oriented Interface

public function doGetDocumentProperty($documentproperty);

Procedural Interface

pdfsdk_pdftext_do_getdocumentproperty($res, $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 (PDFSDK_PDFText Class)

Returns the entire text content contained in the document.

Object Oriented Interface

public function doGetDocumentText();

Procedural Interface

pdfsdk_pdftext_do_getdocumenttext($res);

Remarks

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

GetPageProperty Method (PDFSDK_PDFText Class)

Returns the value of a page property.

Object Oriented Interface

public function doGetPageProperty($pageindex, $pageproperty);

Procedural Interface

pdfsdk_pdftext_do_getpageproperty($res, $pageindex, $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 opens it, performs the operation, then closes it.

GetPageText Method (PDFSDK_PDFText Class)

Returns the text content residing on a specific page.

Object Oriented Interface

public function doGetPageText($pageindex);

Procedural Interface

pdfsdk_pdftext_do_getpagetext($res, $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 (PDFSDK_PDFText Class)

Opens the document for processing.

Object Oriented Interface

public function doOpen();

Procedural Interface

pdfsdk_pdftext_do_open($res);

Remarks

This method is used to open the document specified in InputFile or InputData 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 (PDFSDK_PDFText Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

pdfsdk_pdftext_do_reset($res);

Remarks

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

SaveAttachment Method (PDFSDK_PDFText Class)

Saves a PDF attachment to a file.

Object Oriented Interface

public function doSaveAttachment($index, $filename);

Procedural Interface

pdfsdk_pdftext_do_saveattachment($res, $index, $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 Attachment* properties.

Index is the index of the attachment in the Attachment* properties 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(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

SaveMedia Method (PDFSDK_PDFText Class)

Saves a media object to a file.

Object Oriented Interface

public function doSaveMedia($index, $filename);

Procedural Interface

pdfsdk_pdftext_do_savemedia($res, $index, $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* properties.

Index is the index of the media object in the Media* properties 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();

DocumentInfo Event (PDFSDK_PDFText Class)

Fired when the document has been loaded into memory.

Object Oriented Interface

public function fireDocumentInfo($param);

Procedural Interface

pdfsdk_pdftext_register_callback($res, 1, array($this, 'fireDocumentInfo'));

Parameter List

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

Error Event (PDFSDK_PDFText Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

pdfsdk_pdftext_register_callback($res, 2, array($this, 'fireError'));

Parameter List

'errorcode'
'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

pdfsdk_pdftext_register_callback($res, 3, array($this, 'fireLog'));

Parameter List

'loglevel'
'message'
'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 (PDFSDK_PDFText Class)

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

Object Oriented Interface

public function firePassword($param);

Procedural Interface

pdfsdk_pdftext_register_callback($res, 4, array($this, 'firePassword'));

Parameter List

'available'
'cancel'

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

Fired for each recipient certificate of the encrypted document.

Object Oriented Interface

public function fireRecipientInfo($param);

Procedural Interface

pdfsdk_pdftext_register_callback($res, 5, array($this, 'fireRecipientInfo'));

Parameter List

'issuer'
'serialnumber'
'subjectkeyidentifier'
'available'
'cancel'

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

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