Struct pdfsdk::PDFText

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

pdfsdk::PDFText

Remarks

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

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

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by PDFSDK. Due to this, the PDFText struct cannot be disposed of automatically. Please, call the dispose(&self) method of PDFText when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

attachment_count property (PDFText Struct)

The number of records in the Attachment arrays.

Syntax

fn attachment_count(&self) -> Result<i32, PDFSDKError> 
fn set_attachment_count(&self, value : i32) ->  Option<PDFSDKError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attachment_af_relationship
• attachment_content_type
• attachment_creation_date
• attachment_data
• attachment_description
• attachment_file_name
• attachment_modification_date
• attachment_name
• attachment_size
• attachment_type

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

Data Type

i32

attachment_af_relationship property (PDFText Struct)

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

Syntax

fn attachment_af_relationship(&self, AttachmentIndex : i32) -> Result<String, PDFSDKError> 
fn set_attachment_af_relationship(&self, AttachmentIndex : i32, value : &str) ->  Option<PDFSDKError> 
fn set_attachment_af_relationship_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<PDFSDKError> 

Default Value

""

Remarks

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

Data Type

String

attachment_type property (PDFText Struct)

The type of the attachment.

Syntax

fn attachment_type(&self, AttachmentIndex : i32) -> Result<i32, PDFSDKError> 

Possible Values

0   // Generic
1   // ElectronicInvoice

Default Value

0

Remarks

Possible values are:

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

Data Type

i32

attachment_content_type property (PDFText Struct)

The content type of the attachment.

Syntax

fn attachment_content_type(&self, AttachmentIndex : i32) -> Result<String, PDFSDKError> 
fn set_attachment_content_type(&self, AttachmentIndex : i32, value : &str) ->  Option<PDFSDKError> 
fn set_attachment_content_type_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<PDFSDKError> 

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

Data Type

String

attachment_creation_date property (PDFText Struct)

The creation date of the attachment.

Syntax

fn attachment_creation_date(&self, AttachmentIndex : i32) -> Result<String, PDFSDKError> 
fn set_attachment_creation_date(&self, AttachmentIndex : i32, value : &str) ->  Option<PDFSDKError> 
fn set_attachment_creation_date_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<PDFSDKError> 

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

Data Type

String

attachment_data property (PDFText Struct)

The raw data of the attachment.

Syntax

fn attachment_data(&self, AttachmentIndex : i32) -> Result<Vec<u8>, PDFSDKError> 
fn set_attachment_data(&self, AttachmentIndex : i32, value : Vec<u8>) ->  Option<PDFSDKError> 
fn set_attachment_data_ref(&self, AttachmentIndex : i32, value : &[u8]) ->  Option<PDFSDKError> 

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

Data Type

Vec<u8>

attachment_description property (PDFText Struct)

A textual description of the attachment.

Syntax

fn attachment_description(&self, AttachmentIndex : i32) -> Result<String, PDFSDKError> 
fn set_attachment_description(&self, AttachmentIndex : i32, value : &str) ->  Option<PDFSDKError> 
fn set_attachment_description_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<PDFSDKError> 

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

Data Type

String

attachment_file_name property (PDFText Struct)

The path and filename of the attachment.

Syntax

fn attachment_file_name(&self, AttachmentIndex : i32) -> Result<String, PDFSDKError> 
fn set_attachment_file_name(&self, AttachmentIndex : i32, value : &str) ->  Option<PDFSDKError> 
fn set_attachment_file_name_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<PDFSDKError> 

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

Data Type

String

attachment_modification_date property (PDFText Struct)

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

Syntax

fn attachment_modification_date(&self, AttachmentIndex : i32) -> Result<String, PDFSDKError> 
fn set_attachment_modification_date(&self, AttachmentIndex : i32, value : &str) ->  Option<PDFSDKError> 
fn set_attachment_modification_date_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<PDFSDKError> 

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

Data Type

String

attachment_name property (PDFText Struct)

The name of the attachment.

Syntax

fn attachment_name(&self, AttachmentIndex : i32) -> Result<String, PDFSDKError> 
fn set_attachment_name(&self, AttachmentIndex : i32, value : &str) ->  Option<PDFSDKError> 
fn set_attachment_name_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<PDFSDKError> 

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

Data Type

String

attachment_size property (PDFText Struct)

The attachment's size in bytes.

Syntax

fn attachment_size(&self, AttachmentIndex : i32) -> Result<i64, PDFSDKError> 

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

This property is read-only.

Data Type

i64

decryption_cert_effective_date property (PDFText Struct)

The date on which this certificate becomes valid.

Syntax

fn decryption_cert_effective_date(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_expiration_date property (PDFText Struct)

The date on which the certificate expires.

Syntax

fn decryption_cert_expiration_date(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_extended_key_usage property (PDFText Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn decryption_cert_extended_key_usage(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_fingerprint property (PDFText Struct)

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

Syntax

fn decryption_cert_fingerprint(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_fingerprint_sha1 property (PDFText Struct)

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

Syntax

fn decryption_cert_fingerprint_sha1(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_fingerprint_sha256 property (PDFText Struct)

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

Syntax

fn decryption_cert_fingerprint_sha256(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_issuer property (PDFText Struct)

The issuer of the certificate.

Syntax

fn decryption_cert_issuer(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_private_key property (PDFText Struct)

The private key of the certificate (if available).

Syntax

fn decryption_cert_private_key(&self) -> Result<String, PDFSDKError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

decryption_cert_private_key_available property (PDFText Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn decryption_cert_private_key_available(&self) -> Result<bool, PDFSDKError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

decryption_cert_private_key_container property (PDFText Struct)

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

Syntax

fn decryption_cert_private_key_container(&self) -> Result<String, PDFSDKError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

decryption_cert_public_key property (PDFText Struct)

The public key of the certificate.

Syntax

fn decryption_cert_public_key(&self) -> Result<String, PDFSDKError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

decryption_cert_public_key_algorithm property (PDFText Struct)

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

Syntax

fn decryption_cert_public_key_algorithm(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_public_key_length property (PDFText Struct)

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

Syntax

fn decryption_cert_public_key_length(&self) -> Result<i32, PDFSDKError> 

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.

Data Type

i32

decryption_cert_serial_number property (PDFText Struct)

The serial number of the certificate encoded as a string.

Syntax

fn decryption_cert_serial_number(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_signature_algorithm property (PDFText Struct)

The text description of the certificate's signature algorithm.

Syntax

fn decryption_cert_signature_algorithm(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_store property (PDFText Struct)

The name of the certificate store for the client certificate.

Syntax

fn decryption_cert_store(&self) -> Result<Vec<u8>, PDFSDKError> 
fn set_decryption_cert_store(&self, value : Vec<u8>) ->  Option<PDFSDKError> 
fn set_decryption_cert_store_ref(&self, value : &[u8]) ->  Option<PDFSDKError> 

Default Value

"MY"

Remarks

The decryption_cert_store_type property denotes the type of the certificate store specified by decryption_cert_store. If the store is password-protected, specify the password in decryption_cert_store_password.

decryption_cert_store is used in conjunction with the decryption_cert_subject property to specify client certificates. If decryption_cert_store has a value, and decryption_cert_subject or decryption_cert_encoded is set, a search for a certificate is initiated. Please see the decryption_cert_subject 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).

Data Type

Vec<u8>

decryption_cert_store_password property (PDFText Struct)

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

Syntax

fn decryption_cert_store_password(&self) -> Result<String, PDFSDKError> 
fn set_decryption_cert_store_password(&self, value : &str) ->  Option<PDFSDKError> 
fn set_decryption_cert_store_password_ref(&self, value : &String) ->  Option<PDFSDKError> 

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.

Data Type

String

decryption_cert_store_type property (PDFText Struct)

The type of certificate store for this certificate.

Syntax

fn decryption_cert_store_type(&self) -> Result<i32, PDFSDKError> 
fn set_decryption_cert_store_type(&self, value : i32) ->  Option<PDFSDKError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

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

Data Type

i32

decryption_cert_subject_alt_names property (PDFText Struct)

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

Syntax

fn decryption_cert_subject_alt_names(&self) -> Result<String, PDFSDKError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

decryption_cert_thumbprint_md5 property (PDFText Struct)

The MD5 hash of the certificate.

Syntax

fn decryption_cert_thumbprint_md5(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_thumbprint_sha1 property (PDFText Struct)

The SHA-1 hash of the certificate.

Syntax

fn decryption_cert_thumbprint_sha1(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_thumbprint_sha256 property (PDFText Struct)

The SHA-256 hash of the certificate.

Syntax

fn decryption_cert_thumbprint_sha256(&self) -> Result<String, PDFSDKError> 

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.

Data Type

String

decryption_cert_usage property (PDFText Struct)

The text description of UsageFlags .

Syntax

fn decryption_cert_usage(&self) -> Result<String, PDFSDKError> 

Default Value

""

Remarks

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.

Data Type

String

decryption_cert_usage_flags property (PDFText Struct)

The flags that show intended use for the certificate.

Syntax

fn decryption_cert_usage_flags(&self) -> Result<i32, PDFSDKError> 

Default Value

0

Remarks

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

Please see the decryption_cert_usage property for a text representation of decryption_cert_usage_flags.

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

This property is read-only.

Data Type

i32

decryption_cert_version property (PDFText Struct)

The certificate's version number.

Syntax

fn decryption_cert_version(&self) -> Result<String, PDFSDKError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

decryption_cert_subject property (PDFText Struct)

The subject of the certificate used for client authentication.

Syntax

fn decryption_cert_subject(&self) -> Result<String, PDFSDKError> 
fn set_decryption_cert_subject(&self, value : &str) ->  Option<PDFSDKError> 
fn set_decryption_cert_subject_ref(&self, value : &String) ->  Option<PDFSDKError> 

Default Value

""

Remarks

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.

Data Type

String

decryption_cert_encoded property (PDFText Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn decryption_cert_encoded(&self) -> Result<Vec<u8>, PDFSDKError> 
fn set_decryption_cert_encoded(&self, value : Vec<u8>) ->  Option<PDFSDKError> 
fn set_decryption_cert_encoded_ref(&self, value : &[u8]) ->  Option<PDFSDKError> 

Default Value

""

Remarks

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

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

Data Type

Vec<u8>

input_data property (PDFText Struct)

A byte array containing the PDF document to process.

Syntax

fn input_data(&self) -> Result<Vec<u8>, PDFSDKError> 
fn set_input_data(&self, value : Vec<u8>) ->  Option<PDFSDKError> 
fn set_input_data_ref(&self, value : &[u8]) ->  Option<PDFSDKError> 

Remarks

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

Data Type

Vec<u8>

input_file property (PDFText Struct)

The PDF file to process.

Syntax

fn input_file(&self) -> Result<String, PDFSDKError> 
fn set_input_file(&self, value : &str) ->  Option<PDFSDKError> 
fn set_input_file_ref(&self, value : &String) ->  Option<PDFSDKError> 

Default Value

""

Remarks

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

Data Type

String

media_count property (PDFText Struct)

The number of records in the Media arrays.

Syntax

fn media_count(&self) -> Result<i32, PDFSDKError> 
fn set_media_count(&self, value : i32) ->  Option<PDFSDKError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• media_content_type
• media_data
• media_height
• media_size
• media_width

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

Data Type

i32

media_content_type property (PDFText Struct)

The content type of the media object.

Syntax

fn media_content_type(&self, MediaIndex : i32) -> Result<String, PDFSDKError> 

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

This property is read-only.

Data Type

String

media_data property (PDFText Struct)

The raw data of the media object.

Syntax

fn media_data(&self, MediaIndex : i32) -> Result<Vec<u8>, PDFSDKError> 
fn set_media_data(&self, MediaIndex : i32, value : Vec<u8>) ->  Option<PDFSDKError> 
fn set_media_data_ref(&self, MediaIndex : i32, value : &[u8]) ->  Option<PDFSDKError> 

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

Data Type

Vec<u8>

media_height property (PDFText Struct)

The height of the media object in pixels (i.

Syntax

fn media_height(&self, MediaIndex : i32) -> Result<i32, PDFSDKError> 

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

This property is read-only.

Data Type

i32

media_size property (PDFText Struct)

The size of the media in bytes.

Syntax

fn media_size(&self, MediaIndex : i32) -> Result<i64, PDFSDKError> 

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

This property is read-only.

Data Type

i64

media_width property (PDFText Struct)

The width of the media object in pixels (i.

Syntax

fn media_width(&self, MediaIndex : i32) -> Result<i32, PDFSDKError> 

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

This property is read-only.

Data Type

i32

password property (PDFText Struct)

The password to decrypt the document with.

Syntax

fn password(&self) -> Result<String, PDFSDKError> 
fn set_password(&self, value : &str) ->  Option<PDFSDKError> 
fn set_password_ref(&self, value : &String) ->  Option<PDFSDKError> 

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

pdfa_conformance_level property (PDFText Struct)

The PDF/A conformance level of the document.

Syntax

fn pdfa_conformance_level(&self) -> Result<i32, PDFSDKError> 
fn set_pdfa_conformance_level(&self, value : i32) ->  Option<PDFSDKError> 

Possible Values

0   // None
1   // A1a
2   // A1b
3   // A2a
4   // A2b
5   // A2u
6   // A3a
7   // A3b
8   // A3u
9   // A4
10   // A4e
11   // A4f

Default Value

0

Remarks

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

Possible values are:

Data Type

i32

close method (PDFText Struct)

Closes the opened document.

Syntax

fn close(&self) -> Result<(), PDFSDKError>

Remarks

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

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

config method (PDFText Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) -> Result<String, PDFSDKError>

Remarks

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

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

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

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

encrypted method (PDFText Struct)

Checks whether the document is encrypted.

Syntax

fn encrypted(&self) -> Result<bool, PDFSDKError>

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.

get_document_property method (PDFText Struct)

Returns the value of a document property.

Syntax

fn get_document_property(&self, document_property : &str) -> Result<String, PDFSDKError>

Remarks

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

document_property 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 on_document_info event.

get_document_text method (PDFText Struct)

Returns the entire text content contained in the document.

Syntax

fn get_document_text(&self) -> Result<String, PDFSDKError>

Remarks

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

get_page_property method (PDFText Struct)

Returns the value of a page property.

Syntax

fn get_page_property(&self, page_index : i32, page_property : &str) -> Result<String, PDFSDKError>

Remarks

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

page_index specifies the page to read information about (with a valid range from 0 to page_count - 1), and page_property 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 on_document_info event.

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

get_page_text method (PDFText Struct)

Returns the text content residing on a specific page.

Syntax

fn get_page_text(&self, page_index : i32) -> Result<String, PDFSDKError>

Remarks

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

open method (PDFText Struct)

Opens the document for processing.

Syntax

fn open(&self) -> Result<(), PDFSDKError>

Remarks

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

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

reset method (PDFText Struct)

Resets the struct.

Syntax

fn reset(&self) -> Result<(), PDFSDKError>

Remarks

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

save_attachment method (PDFText Struct)

Saves a PDF attachment to a file.

Syntax

fn save_attachment(&self, index : i32, file_name : &str) -> Result<(), PDFSDKError>

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.

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

save_media method (PDFText Struct)

Saves a media object to a file.

Syntax

fn save_media(&self, index : i32, file_name : &str) -> Result<(), PDFSDKError>

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.

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

on_document_info event (PDFText Struct)

Fired when the document has been loaded into memory.

Syntax

// PDFTextDocumentInfoEventArgs carries the PDFText DocumentInfo event's parameters.
pub struct PDFTextDocumentInfoEventArgs {
  fn page_count(&self) -> i32
}

// PDFTextDocumentInfoEvent defines the signature of the PDFText DocumentInfo event's handler function.
pub trait PDFTextDocumentInfoEvent {
  fn on_document_info(&self, sender : PDFText, e : &mut PDFTextDocumentInfoEventArgs);
}

impl <'a> PDFText<'a> {
  pub fn on_document_info(&self) -> &'a dyn PDFTextDocumentInfoEvent;
  pub fn set_on_document_info(&mut self, value : &'a dyn PDFTextDocumentInfoEvent);
  ...
}

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.

page_count reports the number of pages in the document.

This event is fired when open is called, but only after on_password or on_recipient_info is fired (if applicable) and the document has been decrypted.

on_error event (PDFText Struct)

Fired when information is available about errors during data delivery.

Syntax

// PDFTextErrorEventArgs carries the PDFText Error event's parameters.
pub struct PDFTextErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PDFTextErrorEvent defines the signature of the PDFText Error event's handler function.
pub trait PDFTextErrorEvent {
  fn on_error(&self, sender : PDFText, e : &mut PDFTextErrorEventArgs);
}

impl <'a> PDFText<'a> {
  pub fn on_error(&self) -> &'a dyn PDFTextErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PDFTextErrorEvent);
  ...
}

Remarks

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

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

on_log event (PDFText Struct)

Fired once for each log message.

Syntax

// PDFTextLogEventArgs carries the PDFText Log event's parameters.
pub struct PDFTextLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// PDFTextLogEvent defines the signature of the PDFText Log event's handler function.
pub trait PDFTextLogEvent {
  fn on_log(&self, sender : PDFText, e : &mut PDFTextLogEventArgs);
}

impl <'a> PDFText<'a> {
  pub fn on_log(&self) -> &'a dyn PDFTextLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn PDFTextLogEvent);
  ...
}

Remarks

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

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

message is the log message.

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

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

on_password event (PDFText Struct)

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

Syntax

// PDFTextPasswordEventArgs carries the PDFText Password event's parameters.
pub struct PDFTextPasswordEventArgs {
  fn available(&self) -> bool
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFTextPasswordEvent defines the signature of the PDFText Password event's handler function.
pub trait PDFTextPasswordEvent {
  fn on_password(&self, sender : PDFText, e : &mut PDFTextPasswordEventArgs);
}

impl <'a> PDFText<'a> {
  pub fn on_password(&self) -> &'a dyn PDFTextPasswordEvent;
  pub fn set_on_password(&mut self, value : &'a dyn PDFTextPasswordEvent);
  ...
}

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 struct 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 struct will stop firing this event to request a password.

on_recipient_info event (PDFText Struct)

Fired for each recipient certificate of the encrypted document.

Syntax

// PDFTextRecipientInfoEventArgs carries the PDFText RecipientInfo event's parameters.
pub struct PDFTextRecipientInfoEventArgs {
  fn issuer(&self) -> &String
  fn serial_number(&self) -> &String
  fn subject_key_identifier(&self) -> &String
  fn available(&self) -> bool
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFTextRecipientInfoEvent defines the signature of the PDFText RecipientInfo event's handler function.
pub trait PDFTextRecipientInfoEvent {
  fn on_recipient_info(&self, sender : PDFText, e : &mut PDFTextRecipientInfoEventArgs);
}

impl <'a> PDFText<'a> {
  pub fn on_recipient_info(&self) -> &'a dyn PDFTextRecipientInfoEvent;
  pub fn set_on_recipient_info(&mut self, value : &'a dyn PDFTextRecipientInfoEvent);
  ...
}

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

issuer specifies the subject of the issuer certificate.

serial_number specifies the serial number of the encryption certificate.

subject_key_identifier 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 struct 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 struct 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 Struct)

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

PDFText Config Settings

Base Config Settings

Trappable Errors (PDFText Struct)

PDF Errors

Parsing Errors