PDFForm Class

Properties   Methods   Events   Config Settings   Errors  

The PDFForm class offers PDF form management capabilities.

Syntax

class securepdf.PDFForm

Remarks

The PDF specification defines seven interactive form field types:

• Button
• Check box
• Radio button
• Text box
• List box
• Combo box
• Signature

To begin, provide the input document as a file (input_file), byte array (input_data), or stream (set_input_stream) and call the open method. This method will populate the fields properties with the existing form fields in the document. When finished editing the form, call the close method to close the document and save the changes to either output_file, output_data, or the stream set in set_output_stream.

Adding and Modifying Form Fields

PDFForm includes three additional methods that allow you to customize the form field before it is created. The set_page and set_position methods can be used to specify the form field's location (the page on which it will be added and its position on the page, respectively). If set_page is not explicitly called, the field will be placed on the first page of the document by default. The set_font method can also be used to configure font properties (name, size, style, and color) for form fields that contain text.

Button Fields

A button (also known as pushbutton) field is a button on the form that simply responds as soon as it is clicked. Because of this, it is the only form field that does not retain a permanent value. Use the add_button method to add a button field:

C#
 Copy
int buttonIdx = form.AddButton("button", "Press Me");

The action associated with a button field can be updated to perform specific tasks, such as displaying an alert or triggering a script. The example below assigns a JavaScript action to display an alert message when the button is clicked.

C#
 Copy
form.Fields[buttonIdx].Action = "app.alert('Hello! This is a simple alert message.');";

Check Box Fields

A check box represents a form field that can be toggled between two states: on and off. Use the add_check_box method to add a check box field:

C#
 Copy
int checkBoxIdx = form.AddCheckBox("checkbox", false);

The value associated with a check box field determines whether it will be toggled on or off. The example below toggles the check box on.

C#
 Copy
form.Fields[checkBoxIdx].Value = "true";

Radio Button Fields

Radio button fields are a set of related buttons, each of which - just like check boxes - can be in one of two states: on or off. Radio buttons belong to a radio group in which at most one button in the group may be in the on state at a time. Use the add_radio_button method to add a radio button field:

C#
 Copy
int radioButtonIdx = form.AddRadioButton("radioGroup", "radiobutton", false);
int radioButton2Idx = form.AddRadioButton("radioGroup", "radiobutton2", true);

A radio button field can be modified to change its state. The example below selects the first radio button, switching it on, which automatically deselects the other radio button in the same group, switching it off.

C#
 Copy
form.Fields[radioButtonIdx].Value = "true";

Text Box Fields

A text box field is box or space that allows the user to enter and edit text in a designated area on the form. It can contain default text and can also be configured as a password field to mask the input. Use the add_text_box method to add a text box field:

C#
 Copy
int textBoxIdx = form.AddTextBox("textbox", "Enter your name here", false);

As shown in the example below, the value of a text box field can be modified to fill it with the desired text.

C#
 Copy
form.Fields[textBoxIdx].Value = "My name is John Doe";

List Box Fields

A list box field is a scrollable choice field that displays a list of selectable text items the user can choose from. Use the add_list_box method to add a list box field:

C#
 Copy
int listBoxIdx = form.AddListBox("numbers", "One\r\nTwo\r\nThree", "One");

A list box field can be modified to select one of the options. The example below updates the list box field to select the option "Three".

C#
 Copy
form.Fields[listBoxIdx].Value = "Three";

Combo Box Fields

A combo box field is a choice field that consists of a drop-down list of text items the user can choose from. At most one item may be selected at a time. Compared to list box fields, combo box fields include an editable text box that allows the user to enter a custom value in addition to the predefined options. Use the add_combo_box method to add a combo box field:

C#
 Copy
int comboBoxIdx = form.AddComboBox("colors", "Red\r\nGreen\r\nBlue", "Red");

A combo box field can be modified to select one of the options. The example below updates the combo box field to select the option "Blue".

C#
 Copy
form.Fields[comboBoxIdx].Value = "Blue";

Removing Form Fields

remove_field removes a form field identified by its index, whereas remove_field_by_name removes a field by using its name.

C#
 Copy
form.RemoveField(buttonIdx);
form.RemoveFieldByName("checkbox");

Property List

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

Method List

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

Event List

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

Config Settings

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

decryption_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_decryption_cert_effective_date() -> str: ...

decryption_cert_effective_date = property(get_decryption_cert_effective_date, None)

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.

decryption_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_decryption_cert_expiration_date() -> str: ...

decryption_cert_expiration_date = property(get_decryption_cert_expiration_date, None)

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.

decryption_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_decryption_cert_extended_key_usage() -> str: ...

decryption_cert_extended_key_usage = property(get_decryption_cert_extended_key_usage, None)

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.

decryption_cert_fingerprint property

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

Syntax

def get_decryption_cert_fingerprint() -> str: ...

decryption_cert_fingerprint = property(get_decryption_cert_fingerprint, None)

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.

decryption_cert_fingerprint_sha1 property

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

Syntax

def get_decryption_cert_fingerprint_sha1() -> str: ...

decryption_cert_fingerprint_sha1 = property(get_decryption_cert_fingerprint_sha1, None)

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.

decryption_cert_fingerprint_sha256 property

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

Syntax

def get_decryption_cert_fingerprint_sha256() -> str: ...

decryption_cert_fingerprint_sha256 = property(get_decryption_cert_fingerprint_sha256, None)

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.

decryption_cert_issuer property

The issuer of the certificate.

Syntax

def get_decryption_cert_issuer() -> str: ...

decryption_cert_issuer = property(get_decryption_cert_issuer, None)

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.

decryption_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_decryption_cert_private_key() -> str: ...

decryption_cert_private_key = property(get_decryption_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

decryption_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_decryption_cert_private_key_available() -> bool: ...

decryption_cert_private_key_available = property(get_decryption_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

decryption_cert_private_key_container property

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

Syntax

def get_decryption_cert_private_key_container() -> str: ...

decryption_cert_private_key_container = property(get_decryption_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

decryption_cert_public_key property

The public key of the certificate.

Syntax

def get_decryption_cert_public_key() -> str: ...

decryption_cert_public_key = property(get_decryption_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

decryption_cert_public_key_algorithm property

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

Syntax

def get_decryption_cert_public_key_algorithm() -> str: ...

decryption_cert_public_key_algorithm = property(get_decryption_cert_public_key_algorithm, None)

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.

decryption_cert_public_key_length property

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

Syntax

def get_decryption_cert_public_key_length() -> int: ...

decryption_cert_public_key_length = property(get_decryption_cert_public_key_length, None)

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.

decryption_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_decryption_cert_serial_number() -> str: ...

decryption_cert_serial_number = property(get_decryption_cert_serial_number, None)

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.

decryption_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_decryption_cert_signature_algorithm() -> str: ...

decryption_cert_signature_algorithm = property(get_decryption_cert_signature_algorithm, None)

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.

decryption_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_decryption_cert_store() -> bytes: ...
def set_decryption_cert_store(value: bytes) -> None: ...

decryption_cert_store = property(get_decryption_cert_store, set_decryption_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

decryption_cert_store_password property

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

Syntax

def get_decryption_cert_store_password() -> str: ...
def set_decryption_cert_store_password(value: str) -> None: ...

decryption_cert_store_password = property(get_decryption_cert_store_password, set_decryption_cert_store_password)

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.

decryption_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_decryption_cert_store_type() -> int: ...
def set_decryption_cert_store_type(value: int) -> None: ...

decryption_cert_store_type = property(get_decryption_cert_store_type, set_decryption_cert_store_type)

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

C#
 Copy
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);

decryption_cert_subject_alt_names property

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

Syntax

def get_decryption_cert_subject_alt_names() -> str: ...

decryption_cert_subject_alt_names = property(get_decryption_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

decryption_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_decryption_cert_thumbprint_md5() -> str: ...

decryption_cert_thumbprint_md5 = property(get_decryption_cert_thumbprint_md5, None)

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.

decryption_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_decryption_cert_thumbprint_sha1() -> str: ...

decryption_cert_thumbprint_sha1 = property(get_decryption_cert_thumbprint_sha1, None)

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.

decryption_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_decryption_cert_thumbprint_sha256() -> str: ...

decryption_cert_thumbprint_sha256 = property(get_decryption_cert_thumbprint_sha256, None)

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.

decryption_cert_usage property

The text description of UsageFlags .

Syntax

def get_decryption_cert_usage() -> str: ...

decryption_cert_usage = property(get_decryption_cert_usage, None)

Default Value

""

Remarks

The text description of decryption_cert_usage_flags.

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

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

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

This property is read-only.

decryption_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_decryption_cert_usage_flags() -> int: ...

decryption_cert_usage_flags = property(get_decryption_cert_usage_flags, None)

Default Value

0

Remarks

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

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

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

This property is read-only.

decryption_cert_version property

The certificate's version number.

Syntax

def get_decryption_cert_version() -> str: ...

decryption_cert_version = property(get_decryption_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

decryption_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_decryption_cert_subject() -> str: ...
def set_decryption_cert_subject(value: str) -> None: ...

decryption_cert_subject = property(get_decryption_cert_subject, set_decryption_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

decryption_cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_decryption_cert_encoded() -> bytes: ...
def set_decryption_cert_encoded(value: bytes) -> None: ...

decryption_cert_encoded = property(get_decryption_cert_encoded, set_decryption_cert_encoded)

Default Value

""

Remarks

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

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

field_count property

The number of records in the Field arrays.

Syntax

def get_field_count() -> int: ...

field_count = property(get_field_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• field_action
• field_alt_name
• field_caption
• field_default_value
• field_full_name
• field_height
• field_max_len
• field_name
• field_offset_x
• field_offset_y
• field_options
• field_page_index
• field_terminal
• field_type
• field_value
• field_visible
• field_width

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

This property is read-only.

field_action property

The JavaScript action assigned to the button property.

Syntax

def get_field_action(field_index: int) -> str: ...
def set_field_action(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

The JavaScript action assigned to the button field. This action will be executed if the button is pressed.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_alt_name property

The alternate property name.

Syntax

def get_field_alt_name(field_index: int) -> str: ...
def set_field_alt_name(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

The alternate field name. This optional property contains a friendly name of the field, used when referring to the field in the user interface.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_caption property

The caption of the button property.

Syntax

def get_field_caption(field_index: int) -> str: ...
def set_field_caption(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

The caption of the button field.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_default_value property

The default value of the form property.

Syntax

def get_field_default_value(field_index: int) -> str: ...
def set_field_default_value(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

The default value of the form field.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_name property

The local name of the property.

Syntax

def get_field_name(field_index: int) -> str: ...
def set_field_name(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

The local name of the field. This is normally a simple text string such as mybutton. See also field_full_name.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_type property

The type of the property.

Syntax

def get_field_type(field_index: int) -> int: ...

Default Value

0

Remarks

The type of the field.

Possible values are:

• Undefined (0)
• PushButton (1)
• CheckBox (2)
• RadioGroup (3)
• RadioButton (4)
• Text (5)
• ListBox (6)
• ComboBox (7)
• Signature (8)

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

This property is read-only.

field_full_name property

The full name of the property.

Syntax

def get_field_full_name(field_index: int) -> str: ...

Default Value

""

Remarks

The full name of the field.

This is a concatenation of the local names of the subhierarchy of non-terminal fields leading from the root field to the current field, ending with the local name of the current field. For example, buttons.ctlbuttons.mybutton. See also field_name.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

This property is read-only.

field_height property

The displayed height of the property in points.

Syntax

def get_field_height(field_index: int) -> str: ...
def set_field_height(field_index: int, value: str) -> None: ...

Default Value

"0"

Remarks

The displayed height of the field in points. Both integer and decimal values are supported.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_max_len property

The maximum length of data that the text box can accept.

Syntax

def get_field_max_len(field_index: int) -> int: ...
def set_field_max_len(field_index: int, value: int) -> None: ...

Default Value

0

Remarks

The maximum length of data that the text box can accept.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_offset_x property

The displayed offset of the property from the left-hand page border in points.

Syntax

def get_field_offset_x(field_index: int) -> str: ...
def set_field_offset_x(field_index: int, value: str) -> None: ...

Default Value

"0"

Remarks

The displayed offset of the field from the left-hand page border in points. Both integer and decimal values are supported.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_offset_y property

The displayed offset of the property from the bottom page border in points.

Syntax

def get_field_offset_y(field_index: int) -> str: ...
def set_field_offset_y(field_index: int, value: str) -> None: ...

Default Value

"0"

Remarks

The displayed offset of the field from the bottom page border in points. Both integer and decimal values are supported.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_options property

The set of options offered by a combo box or list box property.

Syntax

def get_field_options(field_index: int) -> str: ...
def set_field_options(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

The set of options offered by a combo box or list box field.

The options are returned as a multi-line string, with each string representing an individual choice. The data reported or accepted by this property depends on the value of the OptionsFormat configuration setting.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_page_index property

The page index containing the property.

Syntax

def get_field_page_index(field_index: int) -> int: ...

Default Value

-1

Remarks

The page index containing the field.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

This property is read-only.

field_terminal property

Whether the property is terminal, meaning it is represented by a leaf entry in the property tree.

Syntax

def get_field_terminal(field_index: int) -> bool: ...

Default Value

TRUE

Remarks

Whether the field is terminal, meaning it is represented by a leaf entry in the field tree.

Only terminal fields can carry data and be filled in or submitted. Any non-terminal (intermediate) fields are only used to define shared properties of a selection of descendant fields, terminal or non-terminal in their own right.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

This property is read-only.

field_value property

The export value associated with the property.

Syntax

def get_field_value(field_index: int) -> str: ...
def set_field_value(field_index: int, value: str) -> None: ...

Default Value

""

Remarks

The export value associated with the field. This contains the data that is the value of the field from the processor's standpoint.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_visible property

Whether the property is visible or hidden.

Syntax

def get_field_visible(field_index: int) -> bool: ...
def set_field_visible(field_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the field is visible or hidden.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

field_width property

The displayed width of the property in points.

Syntax

def get_field_width(field_index: int) -> str: ...
def set_field_width(field_index: int, value: str) -> None: ...

Default Value

"0"

Remarks

The displayed width of the field in points. Both integer and decimal values are supported.

The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the field_count property.

font_color property

The color of the current font in hexadecimal format.

Syntax

def get_font_color() -> str: ...

font_color = property(get_font_color, None)

Default Value

""

Remarks

The color of the current font in hexadecimal format.

This property is read-only.

font_name property

The name of the current font.

Syntax

def get_font_name() -> str: ...

font_name = property(get_font_name, None)

Default Value

"Helvetica"

Remarks

The name of the current font.

This property is read-only.

font_size property

The size of the current font in points.

Syntax

def get_font_size() -> str: ...

font_size = property(get_font_size, None)

Default Value

"12"

Remarks

The size of the current font in points.

This property is read-only.

font_style property

The style of the current font.

Syntax

def get_font_style() -> str: ...

font_style = property(get_font_style, None)

Default Value

""

Remarks

The style of the current font.

This property is read-only.

input_data property

A byte array containing the PDF document to process.

Syntax

def get_input_data() -> bytes: ...
def set_input_data(value: bytes) -> None: ...

input_data = property(get_input_data, set_input_data)

Remarks

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

input_file property

The PDF file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

Default Value

""

Remarks

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

output_data property

A byte array containing the PDF document after processing.

Syntax

def get_output_data() -> bytes: ...

output_data = property(get_output_data, None)

Remarks

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

This property is read-only.

output_file property

The path to a local file where the output will be written.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

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

overwrite property

Whether or not the class should overwrite files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite output_file, output_data, or the stream set in set_output_stream. If set to False, an error will be thrown whenever output_file, output_data, or the stream set in set_output_stream exists before an operation.

password property

The password to decrypt the document with.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

position_page_index property

The index of the current page in the PDF document.

Syntax

def get_position_page_index() -> int: ...

position_page_index = property(get_position_page_index, None)

Default Value

0

Remarks

The index of the current page in the PDF document.

This property is read-only.

position_x property

The X coordinate of the current position on the page.

Syntax

def get_position_x() -> str: ...

position_x = property(get_position_x, None)

Default Value

"0"

Remarks

The X coordinate of the current position on the page.

This property is read-only.

position_y property

The Y coordinate of the current position on the page.

Syntax

def get_position_y() -> str: ...

position_y = property(get_position_y, None)

Default Value

"0"

Remarks

The Y coordinate of the current position on the page.

This property is read-only.

add_bitmap method

Adds a bitmap image at the current position.

Syntax

def add_bitmap(format: str, bitmap_bytes: bytes, bitmap_width: int, bitmap_height: int, width: str, height: str) -> None: ...

Remarks

This function is not available in the current version of the product.

Use this function to add a bitmap image at the specified position. Provide the parameters of the serialized image using the Format, BitmapBytes, BitmapWidth, and BitmapHeight parameters.

Use Width and Height parameters to specify the dimensions, in points, which the image should be scaled/stretched to when placed on the page.

Note: please make sure to provide the original width and height of the bitmap, in pixels, via the BitmapWidth and BitmapHeight parameters.

add_button method

Adds a button field to the form.

Syntax

def add_button(name: str, caption: str) -> int: ...

Remarks

This method is used to create a button field with name Name and caption Caption at the specified position.

The button is added to the end of the fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the fields properties.

add_caption method

Adds a caption for a form field.

Syntax

def add_caption(caption: str) -> None: ...

Remarks

This method is used to add a caption (title) for a form field at the specified position.

add_check_box method

Adds a check box field to the form.

Syntax

def add_check_box(name: str, default_value: bool) -> int: ...

Remarks

This method is used to create a check box field with name Name at the specified position.

The DefaultValue parameter specifies the initial state of the check box (checked/unchecked).

The check box field is added to the end of the fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the fields properties.

add_combo_box method

Adds a combo box field to the form.

Syntax

def add_combo_box(name: str, options: str, default_value: str) -> int: ...

Remarks

This method is used to create a combo box field with name Name at the specified position.

The Options parameter specifies a list of choices as a multi-line string.

The DefaultValue parameter specifies the initial value selected in the combo box.

The new combo box field is added to the end of the fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the fields properties.

add_drawing method

Adds a vector drawing at the current position.

Syntax

def add_drawing(format: str, drawing_bytes: bytes, width: str, height: str) -> None: ...

Remarks

This function is not available in the current version of the product.

Use this function to add a vector drawing at the specified position. Provide the drawing, as an encoded PDF appearance stream, via the DrawingBytes parameter.

Use Width and Height parameters to specify the dimensions, in points, which the drawing should be scaled/stretched to when placed on the page.

add_list_box method

Adds a list box field to the form.

Syntax

def add_list_box(name: str, options: str, default_value: str) -> int: ...

Remarks

This method is used to create a list box field with name Name at the specified position.

The Options parameter specifies a list of choices as a multi-line string.

The DefaultValue parameter specifies the initial value selected in the list box.

The new list box field is added to the end of the fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the fields properties.

add_new_page method

Adds a new blank page to a PDF document.

Syntax

def add_new_page(page_index: int) -> None: ...

Remarks

This method is used to add a new page to the document at the position specified by the PageIndex parameter. Note that when this method returns, the position will not be automatically moved to the newly added page.

add_radio_button method

Adds a radio button to the form.

Syntax

def add_radio_button(radio_group: str, name: str, is_default_button: bool) -> int: ...

Remarks

This method is used to create a radio button field with name Name, within the radio group RadioGroup, at the specified position.

The IsDefaultButton parameter specifies whether the radio button will be selected initially (i.e., whether it will be the of the radio group).

The new radio button field is added to the end of the fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the fields properties.

add_text_box method

Adds a text box field to the form.

Syntax

def add_text_box(name: str, default_value: str, password: bool) -> int: ...

Remarks

This method is used to create a text box field with name Name at the specified position.

The DefaultValue parameter specifies the initial value contained in the text box.

The Password parameter specifies whether the text box is intended to contain a password. If this parameter is True, the text will be displayed as asterisk characters (*).

The new text box field is added to the end of the fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the fields properties.

close method

Closes an opened PDF document.

Syntax

def close() -> None: ...

Remarks

This method is used to close the previously opened document specified in input_file, input_data, or set_input_stream. It should always be preceded by a call to the open method.

Example:

C#
 Copy
component.InputFile = "input.pdf";
component.Open();
// Some operation
component.Close();

If any changes are made to the document, they will be saved automatically to output_file, output_data, or the stream set in set_output_stream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

config method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

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

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

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

create_new method

Creates a new document.

Syntax

def create_new() -> None: ...

Remarks

Use this method to create a blank PDF document with one empty page.

Having created the baseline document, you can use methods of the component (such as AddStream) to add objects to it.

encrypted method

Checks whether a PDF document is encrypted.

Syntax

def encrypted() -> bool: ...

Remarks

This method is used to determine whether or not the document specified in input_file, input_data, or set_input_stream is encrypted. It will return False if the document is pseudo-encrypted with an empty password.

Example:

C#
 Copy
component.InputFile = "input.pdf";
if (component.Encrypted())
{
  // Set Password or DecryptionCert
}
component.Open();
// Some operation
component.Close();

find_field method

Locates a field in the document.

Syntax

def find_field(name: str) -> int: ...

Remarks

This method is used to quickly locate the field with name Name in the document. This method returns the index of the field in the fields properties, or -1 if the field was not found.

flatten method

Flattens the form by removing the interactive form fields.

Syntax

def flatten() -> None: ...

Remarks

This method is used to substitute all the existing form fields in the document with their currently set values, thus fixing them.

This method strips the interactive form features from the document. The flattened fields are no longer fields and can no longer be modified or extracted. Any signatures that may have been included in the original document are removed from the flattened document.

get_field_property method

Retrieves the value of a field property.

Syntax

def get_field_property(field_index: int, field_property: str) -> str: ...

Remarks

This method is used to retrieve the value of a field property. Together with set_field_property, this method provides an extensible way of managing the field settings that are not available through the PDFField type. The list of settings below may be extended in the future.

The FieldIndex parameter is the index of the field of interest in the fields properties, and the FieldProperty parameter specifies the field property to read. The latter can take one of the following values:

Note: Each field property is only populated once the document has been loaded, which is reported by the on_document_info event.

get_page_property method

Retrieves the value of a page property.

Syntax

def get_page_property(page_index: int, page_property: str) -> str: ...

Remarks

This method is used to read general information about the pages of the document specified in input_file, input_data, or set_input_stream, such as their dimensions and content positioning details.

The PageIndex parameter specifies the page to read information about (with a valid range from 0 to PageCount - 1), and the PageProperty parameter specifies the page property to read. The latter can take one of the following values:

Example:

C#
 Copy
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();

C#
 Copy
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: If the document is not already opened, this method will open it, perform the operation, then close it.

open method

Opens a PDF document for processing.

Syntax

def open() -> None: ...

Remarks

This method is used to open the document specified in input_file, input_data, or set_input_stream before performing some operation on it, such as adding, editing, or removing form fields. When finished, call close to complete or discard the operation.

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

NOTE: This method will populate the fields properties with any form fields found in the document.

remove_field method

Removes a field from the document.

Syntax

def remove_field(index: int) -> None: ...

Remarks

This method is used to remove a field from the document. The Index parameter specifies the index of the field in the fields properties to be removed.

NOTE: This method can only be used with terminal fields.

remove_field_by_name method

Removes a field from the document.

Syntax

def remove_field_by_name(name: str) -> None: ...

Remarks

This method is used to remove a field from the document. The Name parameter specifies the full name of the field in the fields properties to be removed.

NOTE: This method can only be used with terminal fields.

reset method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

set_field_property method

Sets the value of a field property.

Syntax

def set_field_property(field_index: int, field_property: str, value: str) -> None: ...

Remarks

This method is used to modify the value of a field property. Together with get_field_property, this method provides an extensible way of managing the field settings that are not available through the PDFField type. The list of settings below may be extended in the future.

The FieldIndex parameter is the index of the field of interest in the fields properties, and the FieldProperty and Value parameters specify the field property and value to set respectively. The former can take one of the following values:

set_font method

Sets the font properties to be applied to form fields.

Syntax

def set_font(name: str, size: str, style: str, color: str) -> None: ...

Remarks

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

The Name parameter specifies the font name.

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

The Style parameter specifies the font style: a combination of bold ("B"), italic ("I"), or underline ("U").

The Color parameter specifies the font color in hexadecimal format.

set_page method

Sets the page to be used as the working page.

Syntax

def set_page(page_index: int) -> None: ...

Remarks

This method is used to specify the page on which all subsequent operations will be performed. The page is identified by the PageIndex parameter.

NOTE: PageIndex set to -1 specifies the last page of the document.

set_position method

Sets the position for form fields.

Syntax

def set_position(x: str, y: str) -> None: ...

Remarks

This method is used to define the position where form fields will be added. The X parameter specifies the horizontal position, and the Y parameter specifies the vertical position.

Values that are absolute, relative to the current position, and relative to the page dimensions are all supported.

Example:

C#
 Copy
// Sets to exact coordinates.
form.SetPosition("100", "20");
// Moves 20 points to the right and 20 points down from the current position.
form.SetPosition("{x}+20", "{y}-20");
// Moves 20 points from the right edge and 120 points from the top edge of the page.
form.SetPosition("{width}-20", "{height}-120");

on_document_info event

Fired when the document has been loaded into memory.

Syntax

class PDFFormDocumentInfoEventParams(object):
  @property
  def page_count() -> int: ...

  @property
  def signature_count() -> int: ...

# In class PDFForm:
@property
def on_document_info() -> Callable[[PDFFormDocumentInfoEventParams], None]: ...
@on_document_info.setter
def on_document_info(event_hook: Callable[[PDFFormDocumentInfoEventParams], None]) -> None: ...

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. These may be useful when preparing the signature. For example, the get_page_property method can be used to find the optimal position for the signature widget.

The PageCount parameter reports the number of pages in the document.

The SignatureCount parameter reports the number of signatures in the document.

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

on_error event

Fired when information is available about errors during data delivery.

Syntax

class PDFFormErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PDFForm:
@property
def on_error() -> Callable[[PDFFormErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PDFFormErrorEventParams], None]) -> None: ...

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log event

Fired once for each log message.

Syntax

class PDFFormLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class PDFForm:
@property
def on_log() -> Callable[[PDFFormLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[PDFFormLogEventParams], None]) -> None: ...

Remarks

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

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

The Message parameter is the log message.

The LogType parameter identifies the type of log entry. Possible values are:

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

on_password event

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

Syntax

class PDFFormPasswordEventParams(object):
  @property
  def available() -> bool: ...

  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class PDFForm:
@property
def on_password() -> Callable[[PDFFormPasswordEventParams], None]: ...
@on_password.setter
def on_password(event_hook: Callable[[PDFFormPasswordEventParams], None]) -> None: ...

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 the password property.

The Available parameter indicates whether the decryption password is already available to the class or still needs to be set. If this parameter is set to False, the correct password must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a password.

on_recipient_info event

Fired for each recipient certificate of the encrypted PDF document.

Syntax

class PDFFormRecipientInfoEventParams(object):
  @property
  def issuer() -> str: ...

  @property
  def serial_number() -> str: ...

  @property
  def subject_key_identifier() -> str: ...

  @property
  def available() -> bool: ...

  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class PDFForm:
@property
def on_recipient_info() -> Callable[[PDFFormRecipientInfoEventParams], None]: ...
@on_recipient_info.setter
def on_recipient_info(event_hook: Callable[[PDFFormRecipientInfoEventParams], None]) -> None: ...

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

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

The SubjectKeyIdentifier parameter specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

The Available parameter indicates whether the decryption certificate is already available to the class or still needs to be set. If this parameter is set to False, the correct certificate must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a certificate.

NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will cause its own invocation of this event.

PDFForm Config Settings

PDFForm Config Settings

Base Config Settings

PDFForm Errors

PDFForm Errors

PDF Errors

Parsing Errors