# Struct securepdf::PDFEdit The PDFEdit struct provides text and document editing capabilities for PDFs. ## Syntax ```text 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](#input_file-property-pdfedit-struct)), byte array ([input_data](#input_data-property-pdfedit-struct)), or stream (set_input_stream) and call [open](#open-method-pdfedit-struct). When finished editing the document, call [close](#close-method-pdfedit-struct) to close it and save the changes to either [output_file](#output_file-property-pdfedit-struct), [output_data](#output_data-property-pdfedit-struct), or the stream set in set_output_stream. ### Search, Replace, and Extract Text Use the [replace_page_text](#replace_page_text-method-pdfedit-struct) and [replace_document_text](#replace_document_text-method-pdfedit-struct) 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](#on_replace_text-event-pdfedit-struct) event during this operation, providing the flexibility of skipping certain text blocks or updating the replacement string on the fly. For example: ```csharp 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](https://www.nsoftware.com/kb/articles/pdfedit-searching-replacing-text) for more details about searching and replacing text. Additionally, the [get_page_text](#get_page_text-method-pdfedit-struct) and [get_document_text](#get_document_text-method-pdfedit-struct) 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](#create_new-method-pdfedit-struct) creates a blank PDF document. - [add_text_block](#add_text_block-method-pdfedit-struct) adds a block of text. - [add_bitmap](#add_bitmap-method-pdfedit-struct) adds an image (JPEG, BMP, or PNG). - [add_drawing](#add_drawing-method-pdfedit-struct) 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](#set_position-method-pdfedit-struct) sets the page to work with and places the cursor at a specific position on the page. - [set_font](#set_font-method-pdfedit-struct) sets the font to use, including its size, style, and color. - [set_alignment](#set_alignment-method-pdfedit-struct) sets the block alignment (left/center/right, top/center/bottom). - [set_transform](#set_transform-method-pdfedit-struct) 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](#append_page-method-pdfedit-struct), [insert_page](#insert_page-method-pdfedit-struct), [remove_page](#remove_page-method-pdfedit-struct), and [remove_pages](#remove_pages-method-pdfedit-struct) methods. To copy pages from one document to another, open each document in an individual PDFEdit object. Then, using [select_page](#select_page-method-pdfedit-struct), 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](#append_page-method-pdfedit-struct) or [insert_page](#insert_page-method-pdfedit-struct). ```csharp 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](#remove_pages-method-pdfedit-struct) to remove the respective subsets of pages from the document, then save each remaining part. For example: ```csharp 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](https://www.nsoftware.com/kb/articles/pdfedit-splitting-merging) 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.* | | | | --- | --- | | [attachment_count](#attachment_count-property-pdfedit-struct) | The number of records in the Attachment arrays. | | [attachment_content_type](#attachment_content_type-property-pdfedit-struct) | The content type of the attachment. | | [attachment_creation_date](#attachment_creation_date-property-pdfedit-struct) | The creation date of the attachment. | | [attachment_data](#attachment_data-property-pdfedit-struct) | The raw data of the attachment. | | [attachment_description](#attachment_description-property-pdfedit-struct) | A textual description of the attachment. | | [attachment_file_name](#attachment_file_name-property-pdfedit-struct) | The path and filename of the attachment. | | [attachment_modification_date](#attachment_modification_date-property-pdfedit-struct) | The date and time of the file's last modification. | | [attachment_name](#attachment_name-property-pdfedit-struct) | The name of the attachment. | | [attachment_size](#attachment_size-property-pdfedit-struct) | The attachment's size in bytes. | | [decryption_cert_effective_date](#decryption_cert_effective_date-property-pdfedit-struct) | The date on which this certificate becomes valid. | | [decryption_cert_expiration_date](#decryption_cert_expiration_date-property-pdfedit-struct) | The date on which the certificate expires. | | [decryption_cert_extended_key_usage](#decryption_cert_extended_key_usage-property-pdfedit-struct) | A comma-delimited list of extended key usage identifiers. | | [decryption_cert_fingerprint](#decryption_cert_fingerprint-property-pdfedit-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [decryption_cert_fingerprint_sha1](#decryption_cert_fingerprint_sha1-property-pdfedit-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [decryption_cert_fingerprint_sha256](#decryption_cert_fingerprint_sha256-property-pdfedit-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [decryption_cert_issuer](#decryption_cert_issuer-property-pdfedit-struct) | The issuer of the certificate. | | [decryption_cert_private_key](#decryption_cert_private_key-property-pdfedit-struct) | The private key of the certificate (if available). | | [decryption_cert_private_key_available](#decryption_cert_private_key_available-property-pdfedit-struct) | Whether a PrivateKey is available for the selected certificate. | | [decryption_cert_private_key_container](#decryption_cert_private_key_container-property-pdfedit-struct) | The name of the PrivateKey container for the certificate (if available). | | [decryption_cert_public_key](#decryption_cert_public_key-property-pdfedit-struct) | The public key of the certificate. | | [decryption_cert_public_key_algorithm](#decryption_cert_public_key_algorithm-property-pdfedit-struct) | The textual description of the certificate's public key algorithm. | | [decryption_cert_public_key_length](#decryption_cert_public_key_length-property-pdfedit-struct) | The length of the certificate's public key (in bits). | | [decryption_cert_serial_number](#decryption_cert_serial_number-property-pdfedit-struct) | The serial number of the certificate encoded as a string. | | [decryption_cert_signature_algorithm](#decryption_cert_signature_algorithm-property-pdfedit-struct) | The text description of the certificate's signature algorithm. | | [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct) | The name of the certificate store for the client certificate. | | [decryption_cert_store_password](#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. | | [decryption_cert_store_type](#decryption_cert_store_type-property-pdfedit-struct) | The type of certificate store for this certificate. | | [decryption_cert_subject_alt_names](#decryption_cert_subject_alt_names-property-pdfedit-struct) | Comma-separated lists of alternative subject names for the certificate. | | [decryption_cert_thumbprint_md5](#decryption_cert_thumbprint_md5-property-pdfedit-struct) | The MD5 hash of the certificate. | | [decryption_cert_thumbprint_sha1](#decryption_cert_thumbprint_sha1-property-pdfedit-struct) | The SHA-1 hash of the certificate. | | [decryption_cert_thumbprint_sha256](#decryption_cert_thumbprint_sha256-property-pdfedit-struct) | The SHA-256 hash of the certificate. | | [decryption_cert_usage](#decryption_cert_usage-property-pdfedit-struct) | The text description of UsageFlags . | | [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfedit-struct) | The flags that show intended use for the certificate. | | [decryption_cert_version](#decryption_cert_version-property-pdfedit-struct) | The certificate's version number. | | [decryption_cert_subject](#decryption_cert_subject-property-pdfedit-struct) | The subject of the certificate used for client authentication. | | [decryption_cert_encoded](#decryption_cert_encoded-property-pdfedit-struct) | The certificate (PEM/Base64 encoded). | | [font_color](#font_color-property-pdfedit-struct) | The color of the current font in hash-prefixed hexadecimal format or as a name. | | [font_name](#font_name-property-pdfedit-struct) | The name of the current font. | | [font_size](#font_size-property-pdfedit-struct) | The size of the current font in points. | | [font_style](#font_style-property-pdfedit-struct) | The style of the current font. | | [input_data](#input_data-property-pdfedit-struct) | A byte array containing the PDF document to process. | | [input_file](#input_file-property-pdfedit-struct) | The PDF file to process. | | [media_count](#media_count-property-pdfedit-struct) | The number of records in the Media arrays. | | [media_content_type](#media_content_type-property-pdfedit-struct) | The content type of the media object. | | [media_data](#media_data-property-pdfedit-struct) | The raw data of the media object. | | [media_height](#media_height-property-pdfedit-struct) | The height of the media object in pixels (i. | | [media_size](#media_size-property-pdfedit-struct) | The size of the media in bytes. | | [media_width](#media_width-property-pdfedit-struct) | The width of the media object in pixels (i. | | [new_page_handle](#new_page_handle-property-pdfedit-struct) | A handle, a unique identifier of the underlying property object. | | [new_page_height](#new_page_height-property-pdfedit-struct) | The height of the page in points. | | [new_page_rotate](#new_page_rotate-property-pdfedit-struct) | The rotation angle of the page in degrees clockwise. | | [new_page_width](#new_page_width-property-pdfedit-struct) | The width of the page in points. | | [output_data](#output_data-property-pdfedit-struct) | A byte array containing the PDF document after processing. | | [output_file](#output_file-property-pdfedit-struct) | The path to a local file where the output is written. | | [overwrite](#overwrite-property-pdfedit-struct) | Whether the struct should overwrite files. | | [password](#password-property-pdfedit-struct) | The password to decrypt the document with. | | [position_page_index](#position_page_index-property-pdfedit-struct) | The index of the current page in the PDF document. | | [position_x](#position_x-property-pdfedit-struct) | The X coordinate of the current position on the page. | | [position_y](#position_y-property-pdfedit-struct) | The Y coordinate of the current position on the page. | | [selected_page_handle](#selected_page_handle-property-pdfedit-struct) | A handle, a unique identifier of the underlying property object. | | [selected_page_height](#selected_page_height-property-pdfedit-struct) | The height of the page in points. | | [selected_page_rotate](#selected_page_rotate-property-pdfedit-struct) | The rotation angle of the page in degrees clockwise. | | [selected_page_width](#selected_page_width-property-pdfedit-struct) | The width of the page in points. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_attachment](#add_attachment-method-pdfedit-struct) | Adds an attachment to the document. | | [add_bitmap](#add_bitmap-method-pdfedit-struct) | Adds a bitmap image to the document. | | [add_drawing](#add_drawing-method-pdfedit-struct) | Adds a vector drawing to the document. | | [add_text_block](#add_text_block-method-pdfedit-struct) | Adds a block of text to the document. | | [append_page](#append_page-method-pdfedit-struct) | Appends a page to the end of the document. | | [close](#close-method-pdfedit-struct) | Closes the opened document. | | [config](#config-method-pdfedit-struct) | Sets or retrieves a configuration setting. | | [convert](#convert-method-pdfedit-struct) | Converts the document to a different format. | | [create_new](#create_new-method-pdfedit-struct) | Creates a new PDF document. | | [encrypted](#encrypted-method-pdfedit-struct) | Checks whether the document is encrypted. | | [get_document_property](#get_document_property-method-pdfedit-struct) | Returns the value of a document property. | | [get_document_text](#get_document_text-method-pdfedit-struct) | Returns the entire text content contained in the document. | | [get_page_property](#get_page_property-method-pdfedit-struct) | Returns the value of a page property. | | [get_page_text](#get_page_text-method-pdfedit-struct) | Returns the text content residing on a specific page. | | [insert_page](#insert_page-method-pdfedit-struct) | Inserts a page into the document. | | [open](#open-method-pdfedit-struct) | Opens the document for processing. | | [remove_attachment](#remove_attachment-method-pdfedit-struct) | Removes an attachment from the document. | | [remove_page](#remove_page-method-pdfedit-struct) | Removes a page from the document. | | [remove_pages](#remove_pages-method-pdfedit-struct) | Removes a subset of pages from the document. | | [replace_document_text](#replace_document_text-method-pdfedit-struct) | Replaces text in the document. | | [replace_page_text](#replace_page_text-method-pdfedit-struct) | Replaces text on a page. | | [reset](#reset-method-pdfedit-struct) | Resets the struct. | | [save_attachment](#save_attachment-method-pdfedit-struct) | Saves a PDF attachment to a file. | | [save_media](#save_media-method-pdfedit-struct) | Saves a media object to a file. | | [select_page](#select_page-method-pdfedit-struct) | Selects a page. | | [set_alignment](#set_alignment-method-pdfedit-struct) | Sets the object alignment for subsequent insertion operations. | | [set_document_property](#set_document_property-method-pdfedit-struct) | Sets the value of a document property. | | [set_font](#set_font-method-pdfedit-struct) | Sets the font properties to be applied to text. | | [set_position](#set_position-method-pdfedit-struct) | Sets the page and position for new text blocks or images. | | [set_transform](#set_transform-method-pdfedit-struct) | Sets the object transformation parameters for subsequent insertion operations. | ## 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.* | | | | --- | --- | | [on_document_info](#on_document_info-event-pdfedit-struct) | Fired when the document has been loaded into memory. | | [on_error](#on_error-event-pdfedit-struct) | Fired when information is available about errors during data delivery. | | [on_log](#on_log-event-pdfedit-struct) | Fired once for each log message. | | [on_password](#on_password-event-pdfedit-struct) | Fired when the struct detects that the document is encrypted with a password. | | [on_recipient_info](#on_recipient_info-event-pdfedit-struct) | Fired for each recipient certificate of the encrypted document. | | [on_replace_text](#on_replace_text-event-pdfedit-struct) | Fired when a substring in the document is due to be replaced. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AFRelationship\[Key\]](#AFRelationship[Key]) | The value of the AFRelationship key for the attachment. | | [AutoTurnPages](#AutoTurnPages) | Whether to change the page automatically upon exceeding the upper or lower page boundary. | | [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether to close the input stream after processing. | | [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Whether to close the output stream after processing. | | [CompressStreams](#CompressStreams) | Whether to compress stream objects. | | [DefaultPageHeight](#DefaultPageHeight) | The default height for newly added pages. | | [DefaultPageWidth](#DefaultPageWidth) | The default width for newly added pages. | | [EnforcePDFA](#EnforcePDFA) | Whether to enforce PDF/A compliance. | | [FallbackFont](#FallbackFont) | The fallback font. | | [FontPaths](#FontPaths) | The font search paths. | | [KeepPositionOnInsert](#KeepPositionOnInsert) | Whether to keep the current position after inserting an element. | | [LoadMedia](#LoadMedia) | Whether to load images from the document. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [OwnerPassword](#OwnerPassword) | The owner password to decrypt the document with. | | [PageCopyByRefElements](#PageCopyByRefElements) | The names of page elements to be copied by reference. | | [PDFALevel](#PDFALevel) | The PDF/A conformance level to enforce. | | [PDFAPolicy](#PDFAPolicy) | The PDF/A policy to follow. | | [RightPadding](#RightPadding) | The width of the whitespace gap to the right of newly added elements. | | [SaveChanges](#SaveChanges) | Whether to save changes made to the document. | | [SystemFontNames](#SystemFontNames) | The system font names. | | [TempPath](#TempPath) | The location where temporary files are stored. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # attachment_count property ([PDFEdit](#struct-securepdfpdfedit) Struct) The number of records in the Attachment arrays. ## Syntax *Rust Syntax* ```text fn attachment_count(&self ) -> Result fn set_attachment_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [attachment_content_type](#attachment_content_type-property-pdfedit-struct) - [attachment_creation_date](#attachment_creation_date-property-pdfedit-struct) - [attachment_data](#attachment_data-property-pdfedit-struct) - [attachment_description](#attachment_description-property-pdfedit-struct) - [attachment_file_name](#attachment_file_name-property-pdfedit-struct) - [attachment_modification_date](#attachment_modification_date-property-pdfedit-struct) - [attachment_name](#attachment_name-property-pdfedit-struct) - [attachment_size](#attachment_size-property-pdfedit-struct) The array indices start at *0* and end at *attachment_count - 1*. ## Data Type i32 # attachment_content_type property ([PDFEdit](#struct-securepdfpdfedit) Struct) The content type of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_content_type(&self , AttachmentIndex : i32) -> Result fn set_attachment_content_type(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_content_type_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## 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](#attachment_count-property-pdfedit-struct) property. ## Data Type String # attachment_creation_date property ([PDFEdit](#struct-securepdfpdfedit) Struct) The creation date of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_creation_date(&self , AttachmentIndex : i32) -> Result fn set_attachment_creation_date(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_creation_date_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## 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](#attachment_count-property-pdfedit-struct) property. ## Data Type String # attachment_data property ([PDFEdit](#struct-securepdfpdfedit) Struct) The raw data of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_data(&self , AttachmentIndex : i32) -> Result, SecurePDFError> fn set_attachment_data(&self, AttachmentIndex : i32, value : Vec) -> Option fn set_attachment_data_ref(&self, AttachmentIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The raw data of the attachment. If [attachment_output_stream](#PDFEdit_p_AttachmentOutputStream) 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](#attachment_count-property-pdfedit-struct) property. ## Data Type Vec # attachment_description property ([PDFEdit](#struct-securepdfpdfedit) Struct) A textual description of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_description(&self , AttachmentIndex : i32) -> Result fn set_attachment_description(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_description_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## 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](#attachment_count-property-pdfedit-struct) property. ## Data Type String # attachment_file_name property ([PDFEdit](#struct-securepdfpdfedit) Struct) The path and filename of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_file_name(&self , AttachmentIndex : i32) -> Result fn set_attachment_file_name(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_file_name_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## 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](#attachment_count-property-pdfedit-struct) property. ## Data Type String # attachment_modification_date property ([PDFEdit](#struct-securepdfpdfedit) Struct) The date and time of the file's last modification. ## Syntax *Rust Syntax* ```text fn attachment_modification_date(&self , AttachmentIndex : i32) -> Result fn set_attachment_modification_date(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_modification_date_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## 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](#attachment_count-property-pdfedit-struct) property. ## Data Type String # attachment_name property ([PDFEdit](#struct-securepdfpdfedit) Struct) The name of the attachment. ## Syntax *Rust Syntax* ```text fn attachment_name(&self , AttachmentIndex : i32) -> Result fn set_attachment_name(&self, AttachmentIndex : i32, value : &str) -> Option fn set_attachment_name_ref(&self, AttachmentIndex : i32, value : &String) -> Option ``` ## 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](#attachment_count-property-pdfedit-struct) property. ## Data Type String # attachment_size property ([PDFEdit](#struct-securepdfpdfedit) Struct) The attachment's size in bytes. ## Syntax *Rust Syntax* ```text fn attachment_size(&self , AttachmentIndex : i32) -> Result ``` ## 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](#attachment_count-property-pdfedit-struct) property. This property is read-only. ## Data Type i64 # decryption_cert_effective_date property ([PDFEdit](#struct-securepdfpdfedit) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn decryption_cert_effective_date(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn decryption_cert_expiration_date(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn decryption_cert_extended_key_usage(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_fingerprint(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_fingerprint_sha1(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_fingerprint_sha256(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_issuer(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn decryption_cert_private_key(&self ) -> Result ``` ## 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](#decryption_cert_private_key-property-pdfedit-struct) may be available but not exportable. In this case, [decryption_cert_private_key](#decryption_cert_private_key-property-pdfedit-struct) returns an empty string. This property is read-only. ## Data Type String # decryption_cert_private_key_available property ([PDFEdit](#struct-securepdfpdfedit) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [decryption_cert_private_key](#decryption_cert_private_key-property-pdfedit-struct) is available for the selected certificate. If [decryption_cert_private_key_available](#decryption_cert_private_key_available-property-pdfedit-struct) 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-securepdfpdfedit) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn decryption_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [decryption_cert_private_key](#decryption_cert_private_key-property-pdfedit-struct) 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-securepdfpdfedit) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_public_key(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn decryption_cert_public_key_algorithm(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn decryption_cert_public_key_length(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn decryption_cert_serial_number(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn decryption_cert_signature_algorithm(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_store(&self ) -> Result, SecurePDFError> fn set_decryption_cert_store(&self, value : Vec) -> Option fn set_decryption_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [decryption_cert_store_type](#decryption_cert_store_type-property-pdfedit-struct) property denotes the type of the certificate store specified by [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct). If the store is password-protected, specify the password in [decryption_cert_store_password](#decryption_cert_store_password-property-pdfedit-struct). [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct) is used in conjunction with the [decryption_cert_subject](#decryption_cert_subject-property-pdfedit-struct) property to specify client certificates. If [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct) has a value, and [decryption_cert_subject](#decryption_cert_subject-property-pdfedit-struct) or [decryption_cert_encoded](#decryption_cert_encoded-property-pdfedit-struct) is set, a search for a certificate is initiated. Please see the [decryption_cert_subject](#decryption_cert_subject-property-pdfedit-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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-securepdfpdfedit) 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 *Rust Syntax* ```text fn decryption_cert_store_password(&self ) -> Result fn set_decryption_cert_store_password(&self, value : &str) -> Option fn set_decryption_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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-securepdfpdfedit) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_store_type(&self ) -> Result fn set_decryption_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [decryption_cert_store_type](#decryption_cert_store_type-property-pdfedit-struct), the full path of the PKCS#11 DLL as the [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct), and the PIN as the [decryption_cert_store_password](#decryption_cert_store_password-property-pdfedit-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct) and set [decryption_cert_store_password](#decryption_cert_store_password-property-pdfedit-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # decryption_cert_subject_alt_names property ([PDFEdit](#struct-securepdfpdfedit) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_subject_alt_names(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_thumbprint_md5(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_thumbprint_sha1(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_thumbprint_sha256(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn decryption_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfedit-struct). 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-securepdfpdfedit) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn decryption_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfedit-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [decryption_cert_usage](#decryption_cert_usage-property-pdfedit-struct) property for a text representation of [decryption_cert_usage_flags](#decryption_cert_usage_flags-property-pdfedit-struct). 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-securepdfpdfedit) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn decryption_cert_version(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn decryption_cert_subject(&self ) -> Result fn set_decryption_cert_subject(&self, value : &str) -> Option fn set_decryption_cert_subject_ref(&self, value : &String) -> Option ``` ## 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: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # decryption_cert_encoded property ([PDFEdit](#struct-securepdfpdfedit) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn decryption_cert_encoded(&self ) -> Result, SecurePDFError> fn set_decryption_cert_encoded(&self, value : Vec) -> Option fn set_decryption_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct) and [decryption_cert_subject](#decryption_cert_subject-property-pdfedit-struct) properties also may be used to specify a certificate. When [decryption_cert_encoded](#decryption_cert_encoded-property-pdfedit-struct) is set, a search is initiated in the current [decryption_cert_store](#decryption_cert_store-property-pdfedit-struct) for the private key of the certificate. If the key is found, [decryption_cert_subject](#decryption_cert_subject-property-pdfedit-struct) is updated to reflect the full subject of the selected certificate; otherwise, [decryption_cert_subject](#decryption_cert_subject-property-pdfedit-struct) is set to an empty string. ## Data Type Vec # font_color property ([PDFEdit](#struct-securepdfpdfedit) Struct) The color of the current font in hash-prefixed hexadecimal format or as a name. ## Syntax *Rust Syntax* ```text fn font_color(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The name of the current font. ## Syntax *Rust Syntax* ```text fn font_name(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The size of the current font in points. ## Syntax *Rust Syntax* ```text fn font_size(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The style of the current font. ## Syntax *Rust Syntax* ```text fn font_style(&self ) -> Result ``` ## Default Value "" ## Remarks The style of the current font. This property is read-only. ## Data Type String # input_data property ([PDFEdit](#struct-securepdfpdfedit) Struct) A byte array containing the PDF document to process. ## Syntax *Rust Syntax* ```text fn input_data(&self ) -> Result, SecurePDFError> fn set_input_data(&self, value : Vec) -> Option fn set_input_data_ref(&self, value : &[u8]) -> Option ``` ## 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-securepdfpdfedit) Struct) The PDF file to process. ## Syntax *Rust Syntax* ```text fn input_file(&self ) -> Result fn set_input_file(&self, value : &str) -> Option fn set_input_file_ref(&self, value : &String) -> Option ``` ## 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-securepdfpdfedit) Struct) The number of records in the Media arrays. ## Syntax *Rust Syntax* ```text fn media_count(&self ) -> Result fn set_media_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [media_content_type](#media_content_type-property-pdfedit-struct) - [media_data](#media_data-property-pdfedit-struct) - [media_height](#media_height-property-pdfedit-struct) - [media_size](#media_size-property-pdfedit-struct) - [media_width](#media_width-property-pdfedit-struct) The array indices start at *0* and end at *media_count - 1*. ## Data Type i32 # media_content_type property ([PDFEdit](#struct-securepdfpdfedit) Struct) The content type of the media object. ## Syntax *Rust Syntax* ```text fn media_content_type(&self , MediaIndex : i32) -> Result ``` ## 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](#media_count-property-pdfedit-struct) property. This property is read-only. ## Data Type String # media_data property ([PDFEdit](#struct-securepdfpdfedit) Struct) The raw data of the media object. ## Syntax *Rust Syntax* ```text fn media_data(&self , MediaIndex : i32) -> Result, SecurePDFError> fn set_media_data(&self, MediaIndex : i32, value : Vec) -> Option fn set_media_data_ref(&self, MediaIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The raw data of the media object. If [media_output_stream](#PDFEdit_p_MediaOutputStream) 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](#media_count-property-pdfedit-struct) property. ## Data Type Vec # media_height property ([PDFEdit](#struct-securepdfpdfedit) Struct) The height of the media object in pixels (i. ## Syntax *Rust Syntax* ```text fn media_height(&self , MediaIndex : i32) -> Result ``` ## 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](#media_count-property-pdfedit-struct) property. This property is read-only. ## Data Type i32 # media_size property ([PDFEdit](#struct-securepdfpdfedit) Struct) The size of the media in bytes. ## Syntax *Rust Syntax* ```text fn media_size(&self , MediaIndex : i32) -> Result ``` ## 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](#media_count-property-pdfedit-struct) property. This property is read-only. ## Data Type i64 # media_width property ([PDFEdit](#struct-securepdfpdfedit) Struct) The width of the media object in pixels (i. ## Syntax *Rust Syntax* ```text fn media_width(&self , MediaIndex : i32) -> Result ``` ## 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](#media_count-property-pdfedit-struct) property. This property is read-only. ## Data Type i32 # new_page_handle property ([PDFEdit](#struct-securepdfpdfedit) Struct) A handle, a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn new_page_handle(&self ) -> Result fn set_new_page_handle(&self, value : i64) -> Option ``` ## 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:** ```php dest.setNewPageHandle(src.getSelectedPageHandle()); ``` ## Data Type i64 # new_page_height property ([PDFEdit](#struct-securepdfpdfedit) Struct) The height of the page in points. ## Syntax *Rust Syntax* ```text fn new_page_height(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The rotation angle of the page in degrees clockwise. ## Syntax *Rust Syntax* ```text fn new_page_rotate(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The width of the page in points. ## Syntax *Rust Syntax* ```text fn new_page_width(&self ) -> Result ``` ## Default Value "0" ## Remarks The width of the page in points. This property is read-only. ## Data Type String # output_data property ([PDFEdit](#struct-securepdfpdfedit) Struct) A byte array containing the PDF document after processing. ## Syntax *Rust Syntax* ```text fn output_data(&self ) -> Result, 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](#output_file-property-pdfedit-struct) and set_output_stream respectively. This property is read-only. ## Data Type Vec # output_file property ([PDFEdit](#struct-securepdfpdfedit) Struct) The path to a local file where the output is written. ## Syntax *Rust Syntax* ```text fn output_file(&self ) -> Result fn set_output_file(&self, value : &str) -> Option fn set_output_file_ref(&self, value : &String) -> Option ``` ## 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-securepdfpdfedit) Struct) Whether the struct should overwrite files. ## Syntax *Rust Syntax* ```text fn overwrite(&self ) -> Result fn set_overwrite(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property indicates whether the struct overwrites [output_file](#output_file-property-pdfedit-struct). If set to *false*, an error is thrown whenever [output_file](#output_file-property-pdfedit-struct) exists before an operation. ## Data Type bool # password property ([PDFEdit](#struct-securepdfpdfedit) Struct) The password to decrypt the document with. ## Syntax *Rust Syntax* ```text fn password(&self ) -> Result fn set_password(&self, value : &str) -> Option fn set_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property is used to provide the user password for decryption. Though it may be different from [OwnerPassword](#OwnerPassword), most implementations use the same value for both. ## Data Type String # position_page_index property ([PDFEdit](#struct-securepdfpdfedit) Struct) The index of the current page in the PDF document. ## Syntax *Rust Syntax* ```text fn position_page_index(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The X coordinate of the current position on the page. ## Syntax *Rust Syntax* ```text fn position_x(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The Y coordinate of the current position on the page. ## Syntax *Rust Syntax* ```text fn position_y(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) A handle, a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn selected_page_handle(&self ) -> Result ``` ## 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:** ```php dest.setNewPageHandle(src.getSelectedPageHandle()); ``` This property is read-only. ## Data Type i64 # selected_page_height property ([PDFEdit](#struct-securepdfpdfedit) Struct) The height of the page in points. ## Syntax *Rust Syntax* ```text fn selected_page_height(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The rotation angle of the page in degrees clockwise. ## Syntax *Rust Syntax* ```text fn selected_page_rotate(&self ) -> Result ``` ## 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-securepdfpdfedit) Struct) The width of the page in points. ## Syntax *Rust Syntax* ```text fn selected_page_width(&self ) -> Result ``` ## Default Value "0" ## Remarks The width of the page in points. This property is read-only. ## Data Type String # add_attachment method ([PDFEdit](#struct-securepdfpdfedit) Struct) Adds an attachment to the document. ## Syntax *Rust Syntax* ```text 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:** ```csharp 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-securepdfpdfedit) Struct) Adds a bitmap image to the document. ## Syntax *Rust Syntax* ```text 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_alignment-method-pdfedit-struct) - [set_position](#set_position-method-pdfedit-struct) - [set_transform](#set_transform-method-pdfedit-struct) # add_drawing method ([PDFEdit](#struct-securepdfpdfedit) Struct) Adds a vector drawing to the document. ## Syntax *Rust Syntax* ```text 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-securepdfpdfedit) Struct) Adds a block of text to the document. ## Syntax *Rust Syntax* ```text 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_alignment-method-pdfedit-struct) - [set_font](#set_font-method-pdfedit-struct) - [set_position](#set_position-method-pdfedit-struct) - [set_transform](#set_transform-method-pdfedit-struct) # append_page method ([PDFEdit](#struct-securepdfpdfedit) Struct) Appends a page to the end of the document. ## Syntax *Rust Syntax* ```text 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-securepdfpdfedit) Struct) Closes the opened document. ## Syntax *Rust Syntax* ```text 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](#open-method-pdfedit-struct). **Example:** ```csharp 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_file-property-pdfedit-struct), [output_data](#output_data-property-pdfedit-struct), or the stream set in set_output_stream when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges). # config method ([PDFEdit](#struct-securepdfpdfedit) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-pdfedit-struct) 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](#config-settings-pdfedit-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # convert method ([PDFEdit](#struct-securepdfpdfedit) Struct) Converts the document to a different format. ## Syntax *Rust Syntax* ```text 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: | Format | Description | | --- | --- | | CompressedPDF | All data streams included in the document are compressed. | | UncompressedPDF | All data streams included in the document are decompressed. | # create_new method ([PDFEdit](#struct-securepdfpdfedit) Struct) Creates a new PDF document. ## Syntax *Rust Syntax* ```text fn create_new(&self) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to create a blank PDF document with one empty page. Use [DefaultPageWidth](#DefaultPageWidth) and [DefaultPageHeight](#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-securepdfpdfedit) Struct) Checks whether the document is encrypted. ## Syntax *Rust Syntax* ```text fn encrypted(&self) -> Result ``` ## Remarks This method is used to determine whether the document is encrypted. It returns *false* if the document is pseudo-encrypted with an empty password. **Example:** ```csharp component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); ``` NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # get_document_property method ([PDFEdit](#struct-securepdfpdfedit) Struct) Returns the value of a document property. ## Syntax *Rust Syntax* ```text fn get_document_property(&self, document_property : &str) -> Result ``` ## Remarks This method is used to obtain the value of a document property. Together with [set_document_property](#set_document_property-method-pdfedit-struct), 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: | Document property | Default value | Description | | --- | --- | --- | | Xmp | "" | The XML body of the XMP metadata embedded in the document. | | Xmp[property] | "" | The value of an XMP metadata property. | | XmpStream | "" | The hex-encoded content of the XMP metadata stream. | **Example:** ```csharp 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](#on_document_info-event-pdfedit-struct) event. # get_document_text method ([PDFEdit](#struct-securepdfpdfedit) Struct) Returns the entire text content contained in the document. ## Syntax *Rust Syntax* ```text fn get_document_text(&self) -> Result ``` ## Remarks This method is used to obtain the whole body of text from the opened document. # get_page_property method ([PDFEdit](#struct-securepdfpdfedit) Struct) Returns the value of a page property. ## Syntax *Rust Syntax* ```text fn get_page_property(&self, page_index : i32, page_property : &str) -> Result ``` ## 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: | Page property | Default value | Description | | --- | --- | --- | | CropLowerLeftX | 0 | The lower-left X coordinate of the page crop area in points. | | CropLowerLeftY | 0 | The lower-left Y coordinate of the page crop area in points. | | CropUpperRightX | 0 | The upper-right X coordinate of the page crop area in points. | | CropUpperRightY | 0 | The upper-right Y coordinate of the page crop area in points. | | Height | 0 | The height of the page in points. | | MediaLowerLeftX | 0 | The lower-left X coordinate of the page media area in points. | | MediaLowerLeftY | 0 | The lower-left Y coordinate of the page media area in points. | | MediaUpperRightX | 0 | The upper-right X coordinate of the page media area in points. | | MediaUpperRightY | 0 | The upper-right Y coordinate of the page media area in points. | | Rotation | 0 | The rotation angle of the page in degrees clockwise. Supported values: 0, 90, 180, 270. | | Width | 0 | The width of the page in points. | **Example:** ```csharp int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); ``` The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: ```csharp int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); ``` NOTE: Each page property is only populated once the document has been loaded, which is reported by the [on_document_info](#on_document_info-event-pdfedit-struct) 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-securepdfpdfedit) Struct) Returns the text content residing on a specific page. ## Syntax *Rust Syntax* ```text fn get_page_text(&self, page_index : i32) -> Result ``` ## 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-securepdfpdfedit) Struct) Inserts a page into the document. ## Syntax *Rust Syntax* ```text 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-securepdfpdfedit) Struct) Opens the document for processing. ## Syntax *Rust Syntax* ```text fn open(&self) -> Result<(), SecurePDFError> ``` ## Remarks This method is used to open the document specified in [input_file](#input_file-property-pdfedit-struct), [input_data](#input_data-property-pdfedit-struct), or set_input_stream before performing some operation on it, such as extracting, editing, or replacing text. When finished, call [close](#close-method-pdfedit-struct) to complete or discard the operation. It is recommended to use this method (alongside [close](#close-method-pdfedit-struct)) when performing multiple operations on the document at once. # remove_attachment method ([PDFEdit](#struct-securepdfpdfedit) Struct) Removes an attachment from the document. ## Syntax *Rust Syntax* ```text 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:** ```csharp 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-securepdfpdfedit) Struct) Removes a page from the document. ## Syntax *Rust Syntax* ```text 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-securepdfpdfedit) Struct) Removes a subset of pages from the document. ## Syntax *Rust Syntax* ```text 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-securepdfpdfedit) Struct) Replaces text in the document. ## Syntax *Rust Syntax* ```text fn replace_document_text(&self, pattern : &str, value : &str) -> Result ``` ## Remarks This method is used to replace all entries of *pattern* with *value* in the whole document. The [on_replace_text](#on_replace_text-event-pdfedit-struct) 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-securepdfpdfedit) Struct) Replaces text on a page. ## Syntax *Rust Syntax* ```text fn replace_page_text(&self, page_index : i32, pattern : &str, value : &str) -> Result ``` ## 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](#on_replace_text-event-pdfedit-struct) 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-securepdfpdfedit) Struct) Resets the struct. ## Syntax *Rust Syntax* ```text 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-securepdfpdfedit) Struct) Saves a PDF attachment to a file. ## Syntax *Rust Syntax* ```text 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:** ```csharp component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); ``` **Example (saving to a stream):** ```csharp component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream 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-securepdfpdfedit) Struct) Saves a media object to a file. ## Syntax *Rust Syntax* ```text 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:** ```csharp pdfedit.InputFile = "input_with_pictures.pdf"; pdfedit.Open(); pdfedit.SaveMedia(0, "picture.jpg"); pdfedit.Close(); ``` **Example (saving to a stream):** ```csharp 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-securepdfpdfedit) Struct) Selects a page. ## Syntax *Rust Syntax* ```text 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-securepdfpdfedit) Struct) Sets the object alignment for subsequent insertion operations. ## Syntax *Rust Syntax* ```text 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](#add_text_block-method-pdfedit-struct) or [add_bitmap](#add_bitmap-method-pdfedit-struct) 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: | | | | --- | --- | | 0 (haLeft - default) | | | 1 (haCenter) | | | 2 (haRight) | | *vertical_alignment* specifies the vertical alignment. Possible values are: | | | | --- | --- | | 0 (vaTop - default) | | | 1 (vaCenter) | | | 2 (vaBottom) | | # set_document_property method ([PDFEdit](#struct-securepdfpdfedit) Struct) Sets the value of a document property. ## Syntax *Rust Syntax* ```text 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](#get_document_property-method-pdfedit-struct), 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: | Document property | Default value | Description | | --- | --- | --- | | Xmp | "" | The XML body of the XMP metadata embedded in the document. | | Xmp[property] | "" | The value of an XMP metadata property. | | XmpStream | "" | The hex-encoded content of the XMP metadata stream. | **Example:** ```csharp 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-securepdfpdfedit) Struct) Sets the font properties to be applied to text. ## Syntax *Rust Syntax* ```text 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: | | | | | | --- | --- | --- | --- | | aliceblue | antiquewhite | aqua | aquamarine | | azure | beige | bisque | black | | blanchedalmond | blue | blueviolet | brown | | burlywood | cadetblue | chartreuse | chocolate | | coral | cornflowerblue | cornsilk | crimson | | cyan | darkblue | darkcyan | darkgoldenrod | | darkgray | darkgrey | darkgreen | darkkhaki | | darkmagenta | darkolivegreen | darkorange | darkorchid | | darkred | darksalmon | darkseagreen | darkslateblue | | darkslategray | darkslategrey | darkturquoise | darkviolet | | deeppink | deepskyblue | dimgray | dimgrey | | dodgerblue | firebrick | floralwhite | forestgreen | | fuchsia | gainsboro | ghostwhite | gold | | goldenrod | gray | grey | green | | greenyellow | honeydew | hotpink | indianred | | indigo | ivory | khaki | lavender | | lavenderblush | lawngreen | lemonchiffon | lightblue | | lightcoral | lightcyan | lightgoldenrodyellow | lightgray | | lightgrey | lightgreen | lightpink | lightsalmon | | lightseagreen | lightskyblue | lightslategray | lightslategrey | | lightsteelblue | lightyellow | lime | limegreen | | linen | magenta | maroon | mediumaquamarine | | mediumblue | mediumorchid | mediumpurple | mediumseagreen | | mediumslateblue | mediumspringgreen | mediumturquoise | mediumvioletred | | midnightblue | mintcream | mistyrose | moccasin | | navajowhite | navy | oldlace | olive | | olivedrab | orange | orangered | orchid | | palegoldenrod | palegreen | paleturquoise | palevioletred | | papayawhip | peachpuff | peru | pink | | plum | powderblue | purple | rebeccapurple | | red | rosybrown | royalblue | saddlebrown | | salmon | sandybrown | seagreen | seashell | | sienna | silver | skyblue | slateblue | | slategray | slategrey | snow | springgreen | | steelblue | tan | teal | thistle | | tomato | turquoise | violet | wheat | | white | whitesmoke | yellow | yellowgreen | # set_position method ([PDFEdit](#struct-securepdfpdfedit) Struct) Sets the page and position for new text blocks or images. ## Syntax *Rust Syntax* ```text 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:** ```csharp // 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-securepdfpdfedit) Struct) Sets the object transformation parameters for subsequent insertion operations. ## Syntax *Rust Syntax* ```text 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](#add_text_block-method-pdfedit-struct) or [add_bitmap](#add_bitmap-method-pdfedit-struct) 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-securepdfpdfedit) Struct) Fired when the document has been loaded into memory. ## Syntax *Rust Syntax* ```text // 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](#open-method-pdfedit-struct) is called, but only after [on_password](#on_password-event-pdfedit-struct) or [on_recipient_info](#on_recipient_info-event-pdfedit-struct) is fired (if applicable) and the document has been decrypted. # on_error event ([PDFEdit](#struct-securepdfpdfedit) Struct) Fired when information is available about errors during data delivery. ## Syntax *Rust Syntax* ```text // 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](#trappable-errors-pdfedit-struct) section. # on_log event ([PDFEdit](#struct-securepdfpdfedit) Struct) Fired once for each log message. ## Syntax *Rust Syntax* ```text // 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](#LogLevel) configuration setting. *log_level* indicates the detail level of the message. Possible values are: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. | | 2 (Verbose) | Detailed data such as HTTP requests are logged. | | 3 (Debug) | Debug data including the full chain validation procedure are logged. | *message* is the log message. *log_type* identifies the type of log entry. Possible values are: - CertValidator - Font - HTTP - PDFInvalidSignature - PDFRevocationInfo - Timestamp - TSL # on_password event ([PDFEdit](#struct-securepdfpdfedit) Struct) Fired when the struct detects that the document is encrypted with a password. ## Syntax *Rust Syntax* ```text // 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](#password-property-pdfedit-struct). *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-securepdfpdfedit) Struct) Fired for each recipient certificate of the encrypted document. ## Syntax *Rust Syntax* ```text // 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-securepdfpdfedit) Struct) Fired when a substring in the document is due to be replaced. ## Syntax *Rust Syntax* ```text // 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](#replace_document_text-method-pdfedit-struct) and [replace_page_text](#replace_page_text-method-pdfedit-struct), 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](#replace_document_text-method-pdfedit-struct) or [replace_page_text](#replace_page_text-method-pdfedit-struct) 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-securepdfpdfedit) 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](#config-method-pdfedit-struct) method. ### PDFEdit Config Settings **AFRelationship[Key]**: The value of the AFRelationship key for the attachment.This setting specifies the value of the AFRelationship key for the attachment. This key in the file specification dictionary expresses the relationship between the attachment and the document, and it must be set for each attachment added to PDF/A-3 documents. *Key* is either the index of the attachment in the attachments collection or the of the attachment. **AutoTurnPages**: Whether to change the page automatically upon exceeding the upper or lower page boundary.This setting specifies whether the struct turns the page automatically. If set to *true*, the struct automatically progresses to the next or previous page upon reaching a page boundary while adding new elements or changing the page position. If set to *false*, any new elements are added to the current page, even if they are outside of the visible page region. The default value is *true*. **CloseInputStreamAfterProcessing**: Whether to close the input stream after processing.This setting determines whether the input stream specified in set_input_stream will be closed after processing is complete. The default value is *true*. **CloseOutputStreamAfterProcessing**: Whether to close the output stream after processing.This setting determines whether the output stream specified in set_output_stream will be closed after processing is complete. The default value is *true*. **CompressStreams**: Whether to compress stream objects.This setting specifies whether the bytes in the document's stream objects are compressed when the document is saved. The default value is *true*. **DefaultPageHeight**: The default height for newly added pages.This setting specifies the default height, in points, of pages added using [create_new](#create_new-method-pdfedit-struct) or [add_new_page](PDFForm.md#PDFForm_m_AddNewPage). The default value is *0*, meaning the struct reuses the height of the previous page when adding a new page. If the new page is the first in the document, the height defaults to the standard *792*. **DefaultPageWidth**: The default width for newly added pages.This setting specifies the default width, in points, of pages added using [create_new](#create_new-method-pdfedit-struct) or [add_new_page](PDFForm.md#PDFForm_m_AddNewPage). The default value is *0*, meaning the struct reuses the width of the previous page when adding a new page. If the new page is the first in the document, the width defaults to the standard *612*. **EnforcePDFA**: Whether to enforce PDF/A compliance.This setting specifies whether the struct enforces PDF/A compliance when operating on the document. If set to *true*, [PDFALevel](#PDFALevel) and [PDFAPolicy](#PDFAPolicy) are used to establish the level of PDF/A compliance to apply. The default value is *true*. **FallbackFont**: The fallback font.This setting specifies the font that the struct uses if it cannot find the intended font on the local system. In PDF/A, fonts must be embedded into the document, so this setting can be useful when text must be added but no font is available. **FontPaths**: The font search paths.This setting specifies a CRLF-separated list of directories where the struct searches for additional TrueType font files. It is used when resolving a TrueType font specified in [set_font](#set_font-method-pdfedit-struct) without a full file path. Each entry is interpreted as a directory path used during font lookup. To use a specific TrueType font file, either specify its filename and include the containing directory in this setting, or specify the full file path in [set_font](#set_font-method-pdfedit-struct). The default value is the system font search paths. These paths are platform-dependent: | | | | --- | --- | | Windows | %windir%\Fonts and %LOCALAPPDATA%\Microsoft\Windows\Fonts | | macOS and iOS | /System/Library/Fonts/, /Library/Fonts/, and ~/Library/Fonts/ | | Linux | Directories listed by dir entries in /etc/fonts/fonts.conf and /usr/local/etc/fonts/fonts.conf | | Android | /system/fonts | On Windows, the .NET and Java editions obtain these locations through the runtime APIs or the *windir*, *SystemRoot*, and *LOCALAPPDATA* environment variables. To use custom directories together with the default system locations, include both to prevent the current search path list from being replaced. For example: ```csharp string fontPaths = component.Config("FontPaths"); fontPaths += @"\r\nC:\Fonts"; component.Config("FontPaths=" + fontPaths); ``` **KeepPositionOnInsert**: Whether to keep the current position after inserting an element.This setting specifies whether the struct keeps the current position at the set value after inserting an element. In the default configuration, insertion of a new element, such as a text block, moves the page position marker to the right of the newly inserted element. If set to *true*, the struct keeps the position marker at its original location after adding the element. The default value is *false*. **LoadMedia**: Whether to load images from the document.This setting specifies whether the struct loads images from the document. If media does not need to be accessed, it can be set to *false* to speed up document processing. The default value is *true*. **LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [on_log](#on_log-event-pdfedit-struct) event. Possible values are: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. | | 2 (Verbose) | Detailed data such as HTTP requests are logged. | | 3 (Debug) | Debug data including the full chain validation procedure are logged. | **OwnerPassword**: The owner password to decrypt the document with.This setting is used to provide the document owner password for decryption. Though it may be different from [password](#password-property-pdfedit-struct), most implementations use the same value for both. **PageCopyByRefElements**: The names of page elements to be copied by reference.This setting specifies a semicolon-separated list of names of page elements that are copied by reference (shallow copy) instead of by value when [append_page](#append_page-method-pdfedit-struct) or [insert_page](#insert_page-method-pdfedit-struct) is called. If set to an empty string, the struct copies all page elements by value, which may lead to inefficient duplication of inherently shared objects such as fonts or bitmaps. The default value is *Resources*. **PDFALevel**: The PDF/A conformance level to enforce.This setting specifies the desired PDF/A conformance level that the struct attempts to enforce when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | 1 | PDF/A-1 | | 2 | PDF/A-2 | | 3 (default) | PDF/A-3 | **PDFAPolicy**: The PDF/A policy to follow.This setting specifies the PDF/A policy the struct follows when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | Default | Maps to Preserve. | | Preserve | Keep existing document features and only write PDF/A-compliant pieces. If the struct needs to write a non-compliant piece, it throws an exception. | | Enforce | Preserve PDF/A-compliant pieces and attempt to fix violations in the original document. | **RightPadding**: The width of the whitespace gap to the right of newly added elements.This setting specifies the width, in points, of the empty space that is allowed to the right of newly added elements. Using a non-zero value for this setting allows multiple text blocks and other elements to be placed next to each other without sticking them together. This setting is ignored if [KeepPositionOnInsert](#KeepPositionOnInsert) is set to *true*. The default value is *5*. **SaveChanges**: Whether to save changes made to the document.This setting specifies whether and how changes made to the PDF document are saved when [close](#close-method-pdfedit-struct) is called. Possible values are: | | | | --- | --- | | 0 | Discard all changes. | | 1 | Save the document to [output_file](#output_file-property-pdfedit-struct), [output_data](#output_data-property-pdfedit-struct), or the stream set in set_output_stream, even if it has not been modified. | | 2 (default) | Save the document to [output_file](#output_file-property-pdfedit-struct), [output_data](#output_data-property-pdfedit-struct), or the stream set in set_output_stream, but only if it has been modified. | **SystemFontNames**: The system font names.This setting returns a CRLF-separated list of system TrueType font names that are supported by the struct. This setting is read-only. **TempPath**: The location where temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. It can be useful to reduce memory usage. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([PDFEdit](#struct-securepdfpdfedit) Struct) ### PDFEdit Errors | | | | --- | --- | | 1203 | Page index is out of bounds. | | 1209 | Invalid PDF structure. | | 1210 | Cannot remove last page. | ### PDF Errors | | | | --- | --- | | 804 | PDF decompression failed. | | 805 | Cannot add entry to cross-reference table. | | 806 | Unsupported field size. | | 807 | Unsupported Encoding filter. | | 808 | Unsupported predictor algorithm. | | 809 | Unsupported document version. | | 812 | Cannot read PDF file stream. | | 813 | Cannot write to PDF file stream. | | 814 | [output_file](#output_file-property-pdfedit-struct) already exists and [overwrite](#overwrite-property-pdfedit-struct) is false. | | 815 | Invalid parameter. | | 817 | Bad cross-reference entry. | | 818 | Invalid object or generation number. | | 819 | Invalid object stream. | | 820 | Invalid stream dictionary. | | 821 | Invalid AcroForm entry. | | 822 | Invalid Root entry. | | 823 | Invalid annotation. | | 824 | The input document is empty. | | 826 | OpenType font error. The error description contains the detailed message. | | 828 | Invalid CMS data. The error description contains the detailed message. | | 835 | Cannot change decryption mode for opened document. | | 836 | Unsupported Date string. | | 838 | Cryptographic error. The error description contains the detailed message. | | 840 | decryption_cert error. The error description contains the detailed message. | | 841 | Encryption failed. The error description contains the detailed message. | | 842 | No proper certificate for encryption found. | | 846 | Unsupported revision. | | 847 | Unsupported security handler SubFilter. | | 848 | Failed to verify permissions. | | 849 | Invalid password. | | 850 | Invalid password information. | | 852 | Unsupported encryption algorithm. | | 859 | Cannot encrypt encrypted document. | | 864 | Cannot modify document after signature update. | | 868 | Cannot encrypt or decrypt object. | | 869 | Invalid security handler information. | | 870 | Invalid encrypted data. | | 871 | Invalid block cipher padding. | | 872 | Failed to reload signature. | | 873 | Object is not encrypted. | | 874 | Unexpected cipher information. | | 877 | Invalid document. Bad document catalog. | | 878 | Invalid document Id. | | 880 | Invalid document. Invalid requirements dictionary. | | 881 | Invalid linearization dictionary. | | 882 | Invalid signature information. | | 883 | Unsupported document format. | | 890 | Unsupported feature. | | 891 | Internal error. The error description contains the detailed message. | | 892 | Unsupported color. | | 893 | This operation is not supported for this PDF/A level. | | 894 | Interactive features ([](#f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [](#f_Action) property of the field. | | 895 | Font file not found. | ### Parsing Errors | | | | --- | --- | | 1001 | Bad object. | | 1002 | Bad document trailer. | | 1003 | Illegal stream dictionary. | | 1004 | Illegal string. | | 1005 | Indirect object expected. | | 1007 | Invalid reference. | | 1008 | Invalid reference table. | | 1009 | Invalid stream data. | | 1010 | Unexpected character. | | 1011 | Unexpected EOF. | | 1012 | Unexpected indirect object in cross-reference table. | | 1013 | RDF object not found. | | 1014 | Invalid RDF object. | | 1015 | Cannot create element with unknown prefix. | | 1021 | Invalid type in Root object list. |