Struct securepdf::PDFEdit

Properties   Methods   Events   Config Settings   Errors  

The PDFEdit struct provides text and document editing capabilities for PDFs.

Syntax

securepdf::PDFEdit

Remarks

The PDFEdit struct can be used to automate search and replace operations, text extraction, content composition, and document merging and splitting.

To begin, provide the input document as a file (input_file), byte array (input_data), or stream (set_input_stream) and call open. When finished editing the document, call close to close it and save the changes to either output_file, output_data, or the stream set in set_output_stream.

Search, Replace, and Extract Text

Use the replace_page_text and replace_document_text methods to iterate through the page or document content and replace all the text elements that match the specified pattern with the provided text. The struct fires the on_replace_text event during this operation, providing the flexibility of skipping certain text blocks or updating the replacement string on the fly. For example: pdfedit.InputFile = "invoice.pdf"; pdfedit.OutputFile = "invoice_filled.pdf"; pdfedit.OnReplaceText += (s, e) => { if (e.Substitute == "/n software") { e.Substitute = "my company"; } }; pdfedit.Open(); int occurrences = pdfedit.ReplacePageText(0, "SELLER_NAME", "/n software"); pdfedit.Close(); Please see this article for more details about searching and replacing text.

Additionally, the get_page_text and get_document_text methods let you extract all the text residing on a specific page or in the entire document.

Content Composition

With PDFEdit, you can also create documents from scratch or add text or images to existing documents using the editing API. This consists of the following four methods:

• create_new creates a blank PDF document.
• add_text_block adds a block of text.
• add_bitmap adds an image (JPEG, BMP, or PNG).
• add_drawing adds a vector drawing.

The above methods are complemented by a set of formatting methods that let you choose the parameters of the added text or image (where, what color, how big, or how skewed):

• set_position sets the page to work with and places the cursor at a specific position on the page.
• set_font sets the font to use, including its size, style, and color.
• set_alignment sets the block alignment (left/center/right, top/center/bottom).
• set_transform sets the transformation matrix, which alters positioning, scaling, rotation angle, and skew.

Document Merging and Splitting

Document-level operations can be performed with the append_page, insert_page, remove_page, and remove_pages methods.

To copy pages from one document to another, open each document in an individual PDFEdit object. Then, using select_page, select the page of document 1 that you want to add to document 2, and assign the PDFPage object populated in its selected_page property to the new_page property of the recipient document. Finally, commit the page to the recipient document using append_page or insert_page. dest.InputFile = "recipient.pdf"; dest.Open(); src.InputFile = "donor.pdf"; src.Open(); src.SelectPage(0); dest.NewPage = src.SelectedPage; dest.AppendPage(); dest.Close(); src.Close(); To split the document in two, use remove_pages to remove the respective subsets of pages from the document, then save each remaining part. For example: pdfedit.InputFile = "input_4_pages.pdf"; pdfedit.Open(); // Remove the pages after page 1, and save the first part (pages 0-1) pdfedit.OutputFile = "input_first.pdf"; pdfedit.RemovePages(2, 2); pdfedit.Close(); // Remove the pages up to and including page 1, and save the second part (pages 2-3) pdfedit.OutputFile = "input_second.pdf"; pdfedit.Open(); pdfedit.RemovePages(0, 2); pdfedit.Close(); Please see this article for more details about splitting and merging PDFs.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecurePDF. Due to this, the PDFEdit struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PDFEdit 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 (PDFEdit Struct)

The number of records in the Attachment arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

i32

attachment_content_type property (PDFEdit Struct)

The content type of the attachment.

Syntax

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

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.

Data Type

String

attachment_creation_date property (PDFEdit Struct)

The creation date of the attachment.

Syntax

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

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.

Data Type

String

attachment_data property (PDFEdit Struct)

The raw data of the attachment.

Syntax

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

Default Value

""

Remarks

The raw data of the attachment.

If attachment_output_stream is not set to a valid stream, the struct writes to this property when an empty string is passed to save_attachment.

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

Data Type

Vec

attachment_description property (PDFEdit Struct)

A textual description of the attachment.

Syntax

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

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.

Data Type

String

attachment_file_name property (PDFEdit Struct)

The path and filename of the attachment.

Syntax

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

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.

Data Type

String

attachment_modification_date property (PDFEdit Struct)

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

Syntax

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

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.

Data Type

String

attachment_name property (PDFEdit Struct)

The name of the attachment.

Syntax

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

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.

Data Type

String

attachment_size property (PDFEdit Struct)

The attachment's size in bytes.

Syntax

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

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.

Data Type

i64

decryption_cert_effective_date property (PDFEdit Struct)

The date on which this certificate becomes valid.

Syntax

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

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 (PDFEdit Struct)

The date on which the certificate expires.

Syntax

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

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 (PDFEdit Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

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

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 (PDFEdit Struct)

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

Syntax

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

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 (PDFEdit Struct)

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

Syntax

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

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 (PDFEdit Struct)

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

Syntax

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

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 (PDFEdit Struct)

The issuer of the certificate.

Syntax

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

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 (PDFEdit Struct)

The private key of the certificate (if available).

Syntax

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

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 (PDFEdit Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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 (PDFEdit Struct)

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

Syntax

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

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 (PDFEdit Struct)

The public key of the certificate.

Syntax

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

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 (PDFEdit Struct)

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

Syntax

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

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 (PDFEdit Struct)

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

Syntax

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

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 (PDFEdit Struct)

The serial number of the certificate encoded as a string.

Syntax

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

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 (PDFEdit Struct)

The text description of the certificate's signature algorithm.

Syntax

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

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 (PDFEdit Struct)

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

decryption_cert_store_password property (PDFEdit 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, SecurePDFError> 
fn set_decryption_cert_store_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_decryption_cert_store_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

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 (PDFEdit Struct)

The type of certificate store for this certificate.

Syntax

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

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 type of certificate store for this certificate.

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 (PDFEdit Struct)

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

Syntax

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

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 (PDFEdit Struct)

The MD5 hash of the certificate.

Syntax

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

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 (PDFEdit Struct)

The SHA-1 hash of the certificate.

Syntax

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

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 (PDFEdit Struct)

The SHA-256 hash of the certificate.

Syntax

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

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 (PDFEdit Struct)

The text description of UsageFlags .

Syntax

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

Default Value

""

Remarks

The text description of decryption_cert_usage_flags.

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 (PDFEdit Struct)

The flags that show intended use for the certificate.

Syntax

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

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 (PDFEdit Struct)

The certificate's version number.

Syntax

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

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 (PDFEdit Struct)

The subject of the certificate used for client authentication.

Syntax

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

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.

Data Type

String

decryption_cert_encoded property (PDFEdit Struct)

The certificate (PEM/Base64 encoded).

Syntax

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

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

font_color property (PDFEdit Struct)

The color of the current font in hash-prefixed hexadecimal format or as a name.

Syntax

fn font_color(&self ) -> Result<String, SecurePDFError> 

Default Value

"#000000"

Remarks

The color of the current font in hash-prefixed hexadecimal format or as a name.

This property is read-only.

Data Type

String

font_name property (PDFEdit Struct)

The name of the current font.

Syntax

fn font_name(&self ) -> Result<String, SecurePDFError> 

Default Value

"Times New Roman"

Remarks

The name of the current font.

This property is read-only.

Data Type

String

font_size property (PDFEdit Struct)

The size of the current font in points.

Syntax

fn font_size(&self ) -> Result<String, SecurePDFError> 

Default Value

"12"

Remarks

The size of the current font in points.

This property is read-only.

Data Type

String

font_style property (PDFEdit Struct)

The style of the current font.

Syntax

fn font_style(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The style of the current font.

This property is read-only.

Data Type

String

input_data property (PDFEdit Struct)

A byte array containing the PDF document to process.

Syntax

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

Remarks

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

Data Type

Vec

input_file property (PDFEdit Struct)

The PDF file to process.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

media_count property (PDFEdit Struct)

The number of records in the Media arrays.

Syntax

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

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 (PDFEdit Struct)

The content type of the media object.

Syntax

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

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.

Data Type

String

media_data property (PDFEdit Struct)

The raw data of the media object.

Syntax

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

Default Value

""

Remarks

The raw data of the media object.

If media_output_stream is not set to a valid stream, the struct writes to this property when an empty string is passed to save_media.

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

Data Type

Vec

media_height property (PDFEdit Struct)

The height of the media object in pixels (i.

Syntax

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

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.

Data Type

i32

media_size property (PDFEdit Struct)

The size of the media in bytes.

Syntax

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

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.

Data Type

i64

media_width property (PDFEdit Struct)

The width of the media object in pixels (i.

Syntax

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

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.

Data Type

i32

new_page_handle property (PDFEdit Struct)

A handle, a unique identifier of the underlying property object.

Syntax

fn new_page_handle(&self ) -> Result<i64, SecurePDFError> 
fn set_new_page_handle(&self, value : i64) ->  Option<SecurePDFError> 

Default Value

0

Remarks

A handle, a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When a handle of one object is passed to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such an operation.

Example: dest.setNewPageHandle(src.getSelectedPageHandle());

Data Type

i64

new_page_height property (PDFEdit Struct)

The height of the page in points.

Syntax

fn new_page_height(&self ) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The height of the page in points.

This property is read-only.

Data Type

String

new_page_rotate property (PDFEdit Struct)

The rotation angle of the page in degrees clockwise.

Syntax

fn new_page_rotate(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The rotation angle of the page in degrees clockwise.

This property is read-only.

Data Type

i32

new_page_width property (PDFEdit Struct)

The width of the page in points.

Syntax

fn new_page_width(&self ) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The width of the page in points.

This property is read-only.

Data Type

String

output_data property (PDFEdit Struct)

A byte array containing the PDF document after processing.

Syntax

fn output_data(&self ) -> Result<Vec<u8>, SecurePDFError> 

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It is only set if an output file and output stream have not been assigned via output_file and set_output_stream respectively.

This property is read-only.

Data Type

Vec

output_file property (PDFEdit Struct)

The path to a local file where the output is written.

Syntax

fn output_file(&self ) -> Result<String, SecurePDFError> 
fn set_output_file(&self, value : &str) ->  Option<SecurePDFError> 
fn set_output_file_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document is saved after the operation has completed.

Data Type

String

overwrite property (PDFEdit Struct)

Whether the struct should overwrite files.

Syntax

fn overwrite(&self ) -> Result<bool, SecurePDFError> 
fn set_overwrite(&self, value : bool) ->  Option<SecurePDFError> 

Default Value

false

Remarks

This property indicates whether the struct overwrites output_file. If set to false, an error is thrown whenever output_file exists before an operation.

Data Type

bool

password property (PDFEdit Struct)

The password to decrypt the document with.

Syntax

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

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

position_page_index property (PDFEdit Struct)

The index of the current page in the PDF document.

Syntax

fn position_page_index(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The index of the current page in the PDF document.

This property is read-only.

Data Type

i32

position_x property (PDFEdit Struct)

The X coordinate of the current position on the page.

Syntax

fn position_x(&self ) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The X coordinate of the current position on the page.

This property is read-only.

Data Type

String

position_y property (PDFEdit Struct)

The Y coordinate of the current position on the page.

Syntax

fn position_y(&self ) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The Y coordinate of the current position on the page.

This property is read-only.

Data Type

String

selected_page_handle property (PDFEdit Struct)

A handle, a unique identifier of the underlying property object.

Syntax

fn selected_page_handle(&self ) -> Result<i64, SecurePDFError> 

Default Value

0

Remarks

A handle, a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When a handle of one object is passed to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such an operation.

Example: dest.setNewPageHandle(src.getSelectedPageHandle());

This property is read-only.

Data Type

i64

selected_page_height property (PDFEdit Struct)

The height of the page in points.

Syntax

fn selected_page_height(&self ) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The height of the page in points.

This property is read-only.

Data Type

String

selected_page_rotate property (PDFEdit Struct)

The rotation angle of the page in degrees clockwise.

Syntax

fn selected_page_rotate(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The rotation angle of the page in degrees clockwise.

This property is read-only.

Data Type

i32

selected_page_width property (PDFEdit Struct)

The width of the page in points.

Syntax

fn selected_page_width(&self ) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The width of the page in points.

This property is read-only.

Data Type

String

add_attachment method (PDFEdit Struct)

Adds an attachment to the document.

Syntax

fn add_attachment(&self, file_name : &str, description : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to add an attachment (embedded file) to the document and to the attachments properties.

file_name and description specify the filename and description of the attachment respectively.

Example: component.InputFile = "input.pdf"; component.OutputFile = "input_with_attachment.pdf"; component.Open(); component.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; component.Attachments.Add(attachment); // Or using one of the constructors: component.Attachments.Add(new PDFAttachment("foo.txt", "desc")); component.Close(); The full list of attachments is contained in the attachments properties.

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

add_bitmap method (PDFEdit Struct)

Adds a bitmap image to the document.

Syntax

fn add_bitmap(&self, format : &str, bitmap_bytes : &[u8], width : i32, height : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to add a bitmap image to the document at the current position and to the media properties.

format and bitmap_bytes specify the format and raw data of the serialized image respectively. Possible values for the former are:

• JPEG2000
• JPEG
• Custom

width and height specify the original width and height of the bitmap in pixels.

The full list of images is contained in the media properties. Use the following methods to adjust new image parameters:

• set_alignment
• set_position
• set_transform

add_drawing method (PDFEdit Struct)

Adds a vector drawing to the document.

Syntax

fn add_drawing(&self, format : &str, drawing_bytes : &[u8]) -> Result<(), SecurePDFError>

Remarks

This method is used to add a vector drawing to the document at the current position.

format and drawing_bytes specify the format and raw data (as an encoded PDF appearance stream) of the drawing respectively. The former is reserved for future use.

add_text_block method (PDFEdit Struct)

Adds a block of text to the document.

Syntax

fn add_text_block(&self, text : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to insert a block of text into the document at the current position. Use the following methods to adjust new text block parameters:

• set_alignment
• set_font
• set_position
• set_transform

append_page method (PDFEdit Struct)

Appends a page to the end of the document.

Syntax

fn append_page(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to append the page specified in new_page to the end of the opened document. If new_page is not set, the struct appends a new blank page.

Note that upon completion of this method, the position will not be automatically moved to the newly appended page.

close method (PDFEdit Struct)

Closes the opened document.

Syntax

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

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(); If any changes are made to the document, they are saved automatically to output_file, output_data, or the stream set in set_output_stream when this method is called. To configure this saving behavior, set SaveChanges.

config method (PDFEdit Struct)

Sets or retrieves a configuration setting.

Syntax

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

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.

convert method (PDFEdit Struct)

Converts the document to a different format.

Syntax

fn convert(&self, format : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to convert the document to the format specified by format. Possible values are:

create_new method (PDFEdit Struct)

Creates a new PDF document.

Syntax

fn create_new(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to create a blank PDF document with one empty page. Use DefaultPageWidth and DefaultPageHeight to adjust the new page dimensions. Having created the baseline document, use the struct's methods to add objects to it.

encrypted method (PDFEdit Struct)

Checks whether the document is encrypted.

Syntax

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

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 (PDFEdit Struct)

Returns the value of a document property.

Syntax

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

Remarks

This method is used to obtain the value of a document property. Together with set_document_property, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

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

Example: pdfedit.InputFile = "input.pdf"; pdfedit.Open(); string description = pdfedit.GetDocumentProperty("Xmp[dc:description]"); string metadataXml = pdfedit.GetDocumentProperty("Xmp"); // Use language descriptors for multi-language properties string descriptionEs = pdfedit.GetDocumentProperty("Xmp[dc:description[es]]"); pdfedit.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 (PDFEdit Struct)

Returns the entire text content contained in the document.

Syntax

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

Remarks

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

get_page_property method (PDFEdit Struct)

Returns the value of a page property.

Syntax

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

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 (PDFEdit Struct)

Returns the text content residing on a specific page.

Syntax

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

Remarks

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

insert_page method (PDFEdit Struct)

Inserts a page into the document.

Syntax

fn insert_page(&self, page_index : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to insert the page specified in new_page into the opened document at the position specified by page_index (zero-based). If new_page is not set, the struct inserts a new blank page.

Note that upon completion of this method, the position will not be automatically moved to the newly inserted page.

open method (PDFEdit Struct)

Opens the document for processing.

Syntax

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

Remarks

This method is used to open the document specified in input_file, input_data, or set_input_stream 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.

remove_attachment method (PDFEdit Struct)

Removes an attachment from the document.

Syntax

fn remove_attachment(&self, index : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to remove an attachment from the document and from the attachments collection.

index is the index of the attachment in the attachments collection to be removed.

Example: pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

remove_page method (PDFEdit Struct)

Removes a page from the document.

Syntax

fn remove_page(&self, page_index : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to remove the page specified by page_index (zero-based) from the opened document.

remove_pages method (PDFEdit Struct)

Removes a subset of pages from the document.

Syntax

fn remove_pages(&self, page_index : i32, count : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to remove a sequence of count pages from the opened document starting at the position specified by page_index (zero-based).

replace_document_text method (PDFEdit Struct)

Replaces text in the document.

Syntax

fn replace_document_text(&self, pattern : &str, value : &str) ->  Result<i32, SecurePDFError>

Remarks

This method is used to replace all entries of pattern with value in the whole document.

The on_replace_text event fires repeatedly during its work to report every new search entry identified in the document. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

replace_page_text method (PDFEdit Struct)

Replaces text on a page.

Syntax

fn replace_page_text(&self, page_index : i32, pattern : &str, value : &str) ->  Result<i32, SecurePDFError>

Remarks

This method is used to replace all entries of pattern with value on the page specified by page_index (zero-based).

The on_replace_text event fires repeatedly during its work to report every new search entry identified on the page. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

reset method (PDFEdit Struct)

Resets the struct.

Syntax

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

Remarks

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

save_attachment method (PDFEdit Struct)

Saves a PDF attachment to a file.

Syntax

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

Remarks

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

index is the index of the attachment in the attachments collection to be saved.

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

save_media method (PDFEdit Struct)

Saves a media object to a file.

Syntax

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

Remarks

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

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

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

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

select_page method (PDFEdit Struct)

Selects a page.

Syntax

fn select_page(&self, page_index : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to select the page specified by page_index (zero-based) and populate its details in the selected_page property. Use page selection to access a page's properties or copy it to another document.

set_alignment method (PDFEdit Struct)

Sets the object alignment for subsequent insertion operations.

Syntax

fn set_alignment(&self, horizontal_alignment : i32, vertical_alignment : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to set the horizontal and vertical alignment parameters to apply when add_text_block or add_bitmap is called. Alignment specifies the position of the newly added text block or image relative to the current position on the page.

horizontal_alignment specifies the horizontal alignment. Possible values are:

vertical_alignment specifies the vertical alignment. Possible values are:

set_document_property method (PDFEdit Struct)

Sets the value of a document property.

Syntax

fn set_document_property(&self, document_property : &str, value : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to adjust properties of the opened document. Together with get_document_property, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

document_property and value specify the document property and value to set respectively. Possible values for the former are:

Example: pdfedit.InputFile = "input.pdf"; pdfedit.Open(); pdfedit.SetDocumentProperty("Xmp[dc:description]", "My first book draft"); pdfedit.SetDocumentProperty("Xmp", "...xml data here..."); // Use language descriptors for multi-language properties pdfedit.SetDocumentProperty("Xmp[dc:description[es]]", "El primer borrador de mi libro"); pdfedit.Close();

set_font method (PDFEdit Struct)

Sets the font properties to be applied to text.

Syntax

fn set_font(&self, name : &str, size : &str, style : &str, color : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to define the font attributes for text.

name specifies the font name.

size specifies the font size, either as an absolute value (e.g., 12) or relative adjustment (e.g., +2).

style specifies the font style. The following syntax is supported:

[B][I][bold][italic][##%][##%,##%][0.###][0.###]

For example:

• bold
• bold 50%
• bold italic 50%
• BI 50% 42%
• B 50% italic 0.42

If only one transparency figure is provided, it applies to both pen and brush.

color specifies the font color in hash-prefixed hexadecimal format (such as #FF0000 for red). The following HTML color aliases are also supported:

set_position method (PDFEdit Struct)

Sets the page and position for new text blocks or images.

Syntax

fn set_position(&self, page_index : i32, x : &str, y : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to define the position where new text blocks or images are added. The page is identified by page_index (zero-based), x specifies the horizontal position, and y specifies the vertical position.

x and y values that are absolute, relative to the current position, and relative to the page dimensions are all supported.

Example: // Sets to exact coordinates. pdfedit.SetPosition(0, "100", "20"); // Moves 20 points to the right and 20 points down from the current position. pdfedit.SetPosition(0, "{x}+20", "{y}-20"); // Moves 20 points from the right edge and 120 points from the top edge of the page. pdfedit.SetPosition(0, "{width}-20", "{height}-120"); NOTE: page_index set to -1 specifies the last page of the document.

set_transform method (PDFEdit Struct)

Sets the object transformation parameters for subsequent insertion operations.

Syntax

fn set_transform(&self, translation_x : &str, translation_y : &str, scale_x : &str, scale_y : &str, rotation : &str, skew_a : &str, skew_b : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to specify the transformation matrix to apply when add_text_block or add_bitmap is called. The transformation matrix defines how the coordinates and content of the newly added text block or image are mapped onto the page.

translation_x and translation_y specify the horizontal and vertical translation of the object in points.

scale_x and scale_y specify the horizontal and vertical scaling of the object (e.g., use 0.5 to scale an image to half its original size).

rotation specifies the rotation angle of the object in degrees counterclockwise.

skew_a and skew_b specify the horizontal and vertical skew angles of the object in degrees (e.g., use 30 and 20 respectively to slant the object by 30 degrees horizontally and 20 degrees vertically).

on_document_info event (PDFEdit Struct)

Fired when the document has been loaded into memory.

Syntax

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

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

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

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 (PDFEdit Struct)

Fired when information is available about errors during data delivery.

Syntax

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

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

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

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 (PDFEdit Struct)

Fired once for each log message.

Syntax

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

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

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

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 (PDFEdit Struct)

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

Syntax

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

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

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

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 (PDFEdit Struct)

Fired for each recipient certificate of the encrypted document.

Syntax

// PDFEditRecipientInfoEventArgs carries the PDFEdit RecipientInfo event's parameters.
pub struct PDFEditRecipientInfoEventArgs {
  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)
}

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

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

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.

on_replace_text event (PDFEdit Struct)

Fired when a substring in the document is due to be replaced.

Syntax

// PDFEditReplaceTextEventArgs carries the PDFEdit ReplaceText event's parameters.
pub struct PDFEditReplaceTextEventArgs {
  fn page_index(&self) -> i32
  fn entry_index(&self) -> i32
  fn offset(&self) -> i32
  fn pattern(&self) -> &String
  fn substitute(&self) -> &String
  fn set_substitute(&self, value : &str)
  fn set_substitute_ref(&self, value : &String)
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// PDFEditReplaceTextEvent defines the signature of the PDFEdit ReplaceText event's handler function.
pub trait PDFEditReplaceTextEvent {
  fn on_replace_text(&self, sender : PDFEdit, e : &mut PDFEditReplaceTextEventArgs);
}

impl <'a> PDFEdit<'a> {
  pub fn on_replace_text(&self) -> &'a dyn PDFEditReplaceTextEvent;
  pub fn set_on_replace_text(&mut self, value : &'a dyn PDFEditReplaceTextEvent);
  ...
}

Remarks

This event is fired from within replace_document_text and replace_page_text, repeatedly, for each located pattern string. It may be used to track and, if required, alter individual text substitutions.

page_index contains the page number where the entry is located.

entry_index contains the index number of the entry related to the other entries.

offset specifies the offset of the substring from the beginning of the page or document.

substitute contains the value that pattern will be replaced with. This value matches the value parameter passed to the respective replace_document_text or replace_page_text call. Adjust it from the event handler if required.

skip determines whether the struct will skip substituting this entry and proceed to the next one.

Config Settings (PDFEdit 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.

PDFEdit Config Settings

Base Config Settings

Trappable Errors (PDFEdit Struct)

PDFEdit Errors

PDF Errors

Parsing Errors