PDFForm Control

Properties   Methods   Events   Config Settings   Errors  

The PDFForm control offers PDF form management capabilities.

Syntax

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 (InputFile), byte array (InputData), or stream (SetInputStream) 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 OutputFile, OutputData, or the stream set in SetOutputStream.

Adding and Modifying Form Fields

PDFForm includes three additional methods that allow you to customize the form field before it is created. The SetPage and SetPosition 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 SetPage is not explicitly called, the field will be placed on the first page of the document by default. The SetFont 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 AddButton 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 AddCheckBox 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 AddRadioButton 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 AddTextBox 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 AddListBox 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 AddComboBox 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

RemoveField removes a form field identified by its index, whereas RemoveFieldByName 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 control with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

DecryptionCertEffectiveDate Property (PDFForm Control)

The date on which this certificate becomes valid.

Syntax

pdfformcontrol.DecryptionCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

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

Data Type

String

DecryptionCertExpirationDate Property (PDFForm Control)

The date on which the certificate expires.

Syntax

pdfformcontrol.DecryptionCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

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

Data Type

String

DecryptionCertExtendedKeyUsage Property (PDFForm Control)

A comma-delimited list of extended key usage identifiers.

Syntax

pdfformcontrol.DecryptionCertExtendedKeyUsage

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertFingerprint Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

Data Type

String

DecryptionCertFingerprintSHA1 Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

Data Type

String

DecryptionCertFingerprintSHA256 Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

Data Type

String

DecryptionCertIssuer Property (PDFForm Control)

The issuer of the certificate.

Syntax

pdfformcontrol.DecryptionCertIssuer

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertPrivateKey Property (PDFForm Control)

The private key of the certificate (if available).

Syntax

pdfformcontrol.DecryptionCertPrivateKey

Default Value

""

Remarks

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

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

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

Data Type

String

DecryptionCertPrivateKeyAvailable Property (PDFForm Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

pdfformcontrol.DecryptionCertPrivateKeyAvailable

Default Value

False

Remarks

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

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

Data Type

Boolean

DecryptionCertPrivateKeyContainer Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertPrivateKeyContainer

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertPublicKey Property (PDFForm Control)

The public key of the certificate.

Syntax

pdfformcontrol.DecryptionCertPublicKey

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertPublicKeyAlgorithm Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

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

Data Type

String

DecryptionCertPublicKeyLength Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertPublicKeyLength

Default Value

0

Remarks

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

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

Data Type

Integer

DecryptionCertSerialNumber Property (PDFForm Control)

The serial number of the certificate encoded as a string.

Syntax

pdfformcontrol.DecryptionCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

Data Type

String

DecryptionCertSignatureAlgorithm Property (PDFForm Control)

The text description of the certificate's signature algorithm.

Syntax

pdfformcontrol.DecryptionCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

Data Type

String

DecryptionCertStore Property (PDFForm Control)

The name of the certificate store for the client certificate.

Syntax

pdfformcontrol.DecryptionCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DecryptionCertStoreB.

This property is not available at design time.

Data Type

Binary String

DecryptionCertStorePassword Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertStorePassword[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertStoreType Property (PDFForm Control)

The type of certificate store for this certificate.

Syntax

pdfformcontrol.DecryptionCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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);

This property is not available at design time.

Data Type

Integer

DecryptionCertSubjectAltNames Property (PDFForm Control)

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

Syntax

pdfformcontrol.DecryptionCertSubjectAltNames

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertThumbprintMD5 Property (PDFForm Control)

The MD5 hash of the certificate.

Syntax

pdfformcontrol.DecryptionCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

DecryptionCertThumbprintSHA1 Property (PDFForm Control)

The SHA-1 hash of the certificate.

Syntax

pdfformcontrol.DecryptionCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

DecryptionCertThumbprintSHA256 Property (PDFForm Control)

The SHA-256 hash of the certificate.

Syntax

pdfformcontrol.DecryptionCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

Data Type

String

DecryptionCertUsage Property (PDFForm Control)

The text description of UsageFlags .

Syntax

pdfformcontrol.DecryptionCertUsage

Default Value

""

Remarks

The text description of DecryptionCertUsageFlags.

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

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

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

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

Data Type

String

DecryptionCertUsageFlags Property (PDFForm Control)

The flags that show intended use for the certificate.

Syntax

pdfformcontrol.DecryptionCertUsageFlags

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

DecryptionCertVersion Property (PDFForm Control)

The certificate's version number.

Syntax

pdfformcontrol.DecryptionCertVersion

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertSubject Property (PDFForm Control)

The subject of the certificate used for client authentication.

Syntax

pdfformcontrol.DecryptionCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

DecryptionCertEncoded Property (PDFForm Control)

The certificate (PEM/Base64 encoded).

Syntax

pdfformcontrol.DecryptionCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DecryptionCertEncodedB.

This property is not available at design time.

Data Type

Binary String

FieldCount Property (PDFForm Control)

The number of records in the Field arrays.

Syntax

pdfformcontrol.FieldCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• FieldAction
• FieldAltName
• FieldCaption
• FieldDefaultValue
• FieldFullName
• FieldHeight
• FieldMaxLen
• FieldName
• FieldOffsetX
• FieldOffsetY
• FieldOptions
• FieldPageIndex
• FieldTerminal
• FieldType
• FieldValue
• FieldVisible
• FieldWidth

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

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

Data Type

Integer

FieldAction Property (PDFForm Control)

The JavaScript action assigned to the button property.

Syntax

pdfformcontrol.FieldAction(FieldIndex)[=string]

Default Value

""

Remarks

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

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldAltName Property (PDFForm Control)

The alternate property name.

Syntax

pdfformcontrol.FieldAltName(FieldIndex)[=string]

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 FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldCaption Property (PDFForm Control)

The caption of the button property.

Syntax

pdfformcontrol.FieldCaption(FieldIndex)[=string]

Default Value

""

Remarks

The caption of the button field.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldDefaultValue Property (PDFForm Control)

The default value of the form property.

Syntax

pdfformcontrol.FieldDefaultValue(FieldIndex)[=string]

Default Value

""

Remarks

The default value of the form field.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldName Property (PDFForm Control)

The local name of the property.

Syntax

pdfformcontrol.FieldName(FieldIndex)[=string]

Default Value

""

Remarks

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

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldType Property (PDFForm Control)

The type of the property.

Syntax

pdfformcontrol.FieldType(FieldIndex)

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 FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

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

Data Type

Integer

FieldFullName Property (PDFForm Control)

The full name of the property.

Syntax

pdfformcontrol.FieldFullName(FieldIndex)

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

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

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

Data Type

String

FieldHeight Property (PDFForm Control)

The displayed height of the property in points.

Syntax

pdfformcontrol.FieldHeight(FieldIndex)[=string]

Default Value

"0"

Remarks

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

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldMaxLen Property (PDFForm Control)

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

Syntax

pdfformcontrol.FieldMaxLen(FieldIndex)[=integer]

Default Value

0

Remarks

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

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

Integer

FieldOffsetX Property (PDFForm Control)

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

Syntax

pdfformcontrol.FieldOffsetX(FieldIndex)[=string]

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 FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldOffsetY Property (PDFForm Control)

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

Syntax

pdfformcontrol.FieldOffsetY(FieldIndex)[=string]

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 FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldOptions Property (PDFForm Control)

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

Syntax

pdfformcontrol.FieldOptions(FieldIndex)[=string]

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 FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldPageIndex Property (PDFForm Control)

The page index containing the property.

Syntax

pdfformcontrol.FieldPageIndex(FieldIndex)

Default Value

-1

Remarks

The page index containing the field.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

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

Data Type

Integer

FieldTerminal Property (PDFForm Control)

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

Syntax

pdfformcontrol.FieldTerminal(FieldIndex)

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 FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

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

Data Type

Boolean

FieldValue Property (PDFForm Control)

The export value associated with the property.

Syntax

pdfformcontrol.FieldValue(FieldIndex)[=string]

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 FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FieldVisible Property (PDFForm Control)

Whether the property is visible or hidden.

Syntax

pdfformcontrol.FieldVisible(FieldIndex)[=boolean]

Default Value

False

Remarks

Whether the field is visible or hidden.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

Boolean

FieldWidth Property (PDFForm Control)

The displayed width of the property in points.

Syntax

pdfformcontrol.FieldWidth(FieldIndex)[=string]

Default Value

"0"

Remarks

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

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FieldCount property.

This property is not available at design time.

Data Type

String

FontColor Property (PDFForm Control)

The color of the current font in hexadecimal format.

Syntax

pdfformcontrol.FontColor

Default Value

""

Remarks

The color of the current font in hexadecimal format.

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

Data Type

String

FontName Property (PDFForm Control)

The name of the current font.

Syntax

pdfformcontrol.FontName

Default Value

"Helvetica"

Remarks

The name of the current font.

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

Data Type

String

FontSize Property (PDFForm Control)

The size of the current font in points.

Syntax

pdfformcontrol.FontSize

Default Value

"12"

Remarks

The size of the current font in points.

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

Data Type

String

FontStyle Property (PDFForm Control)

The style of the current font.

Syntax

pdfformcontrol.FontStyle

Default Value

""

Remarks

The style of the current font.

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

Data Type

String

InputData Property (PDFForm Control)

A byte array containing the PDF document to process.

Syntax

pdfformcontrol.InputData[=byte array]

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFForm Control)

The PDF file to process.

Syntax

pdfformcontrol.InputFile[=string]

Default Value

""

Remarks

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

Data Type

String

OutputData Property (PDFForm Control)

A byte array containing the PDF document after processing.

Syntax

pdfformcontrol.OutputData

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 OutputFile and SetOutputStream respectively.

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

Data Type

Byte Array

OutputFile Property (PDFForm Control)

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

Syntax

pdfformcontrol.OutputFile[=string]

Default Value

""

Remarks

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

Data Type

String

Overwrite Property (PDFForm Control)

Whether or not the control should overwrite files.

Syntax

pdfformcontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property indicates whether or not the control will overwrite OutputFile, OutputData, or the stream set in SetOutputStream. If set to , an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Data Type

Boolean

Password Property (PDFForm Control)

The password to decrypt the document with.

Syntax

pdfformcontrol.Password[=string]

Default Value

""

Remarks

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

Data Type

String

PositionPageIndex Property (PDFForm Control)

The index of the current page in the PDF document.

Syntax

pdfformcontrol.PositionPageIndex

Default Value

0

Remarks

The index of the current page in the PDF document.

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

Data Type

Integer

PositionX Property (PDFForm Control)

The X coordinate of the current position on the page.

Syntax

pdfformcontrol.PositionX

Default Value

"0"

Remarks

The X coordinate of the current position on the page.

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

Data Type

String

PositionY Property (PDFForm Control)

The Y coordinate of the current position on the page.

Syntax

pdfformcontrol.PositionY

Default Value

"0"

Remarks

The Y coordinate of the current position on the page.

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

Data Type

String

AddBitmap Method (PDFForm Control)

Adds a bitmap image at the current position.

Syntax

pdfformcontrol.AddBitmap Format, BitmapBytes, BitmapWidth, BitmapHeight, Width, Height

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.

AddButton Method (PDFForm Control)

Adds a button field to the form.

Syntax

pdfformcontrol.AddButton Name, Caption

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.

AddCaption Method (PDFForm Control)

Adds a caption for a form field.

Syntax

pdfformcontrol.AddCaption Caption

Remarks

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

AddCheckBox Method (PDFForm Control)

Adds a check box field to the form.

Syntax

pdfformcontrol.AddCheckBox Name, DefaultValue

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.

AddComboBox Method (PDFForm Control)

Adds a combo box field to the form.

Syntax

pdfformcontrol.AddComboBox Name, Options, DefaultValue

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.

AddDrawing Method (PDFForm Control)

Adds a vector drawing at the current position.

Syntax

pdfformcontrol.AddDrawing Format, DrawingBytes, Width, Height

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.

AddListBox Method (PDFForm Control)

Adds a list box field to the form.

Syntax

pdfformcontrol.AddListBox Name, Options, DefaultValue

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.

AddNewPage Method (PDFForm Control)

Adds a new blank page to a PDF document.

Syntax

pdfformcontrol.AddNewPage PageIndex

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.

AddRadioButton Method (PDFForm Control)

Adds a radio button to the form.

Syntax

pdfformcontrol.AddRadioButton RadioGroup, Name, IsDefaultButton

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.

AddTextBox Method (PDFForm Control)

Adds a text box field to the form.

Syntax

pdfformcontrol.AddTextBox Name, DefaultValue, Password

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 , 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 (PDFForm Control)

Closes an opened PDF document.

Syntax

pdfformcontrol.Close 

Remarks

This method is used to close the previously opened document specified in InputFile, InputData, or SetInputStream. 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 OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (PDFForm Control)

Sets or retrieves a configuration setting.

Syntax

pdfformcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

CreateNew Method (PDFForm Control)

Creates a new document.

Syntax

pdfformcontrol.CreateNew 

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 (PDFForm Control)

Checks whether a PDF document is encrypted.

Syntax

pdfformcontrol.Encrypted 

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return 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();

FindField Method (PDFForm Control)

Locates a field in the document.

Syntax

pdfformcontrol.FindField Name

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 (PDFForm Control)

Flattens the form by removing the interactive form fields.

Syntax

pdfformcontrol.Flatten 

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.

GetFieldProperty Method (PDFForm Control)

Retrieves the value of a field property.

Syntax

pdfformcontrol.GetFieldProperty FieldIndex, FieldProperty

Remarks

This method is used to retrieve the value of a field property. Together with SetFieldProperty, 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 DocumentInfo event.

GetPageProperty Method (PDFForm Control)

Retrieves the value of a page property.

Syntax

pdfformcontrol.GetPageProperty PageIndex, PageProperty

Remarks

This method is used to read general information about the pages of the document specified in InputFile, InputData, or SetInputStream, 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 (PDFForm Control)

Opens a PDF document for processing.

Syntax

pdfformcontrol.Open 

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream 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.

RemoveField Method (PDFForm Control)

Removes a field from the document.

Syntax

pdfformcontrol.RemoveField Index

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.

RemoveFieldByName Method (PDFForm Control)

Removes a field from the document.

Syntax

pdfformcontrol.RemoveFieldByName Name

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 (PDFForm Control)

Resets the control.

Syntax

pdfformcontrol.Reset 

Remarks

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

SetFieldProperty Method (PDFForm Control)

Sets the value of a field property.

Syntax

pdfformcontrol.SetFieldProperty FieldIndex, FieldProperty, Value

Remarks

This method is used to modify the value of a field property. Together with GetFieldProperty, 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:

SetFont Method (PDFForm Control)

Sets the font properties to be applied to form fields.

Syntax

pdfformcontrol.SetFont Name, Size, Style, Color

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.

SetPage Method (PDFForm Control)

Sets the page to be used as the working page.

Syntax

pdfformcontrol.SetPage PageIndex

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.

SetPosition Method (PDFForm Control)

Sets the position for form fields.

Syntax

pdfformcontrol.SetPosition X, Y

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");

DocumentInfo Event (PDFForm Control)

Fired when the document has been loaded into memory.

Syntax

Sub pdfformcontrol_DocumentInfo(PageCount As Integer, SignatureCount As Integer)

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 GetPageProperty 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 Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFForm Control)

Fired when information is available about errors during data delivery.

Syntax

Sub pdfformcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

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

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

Log Event (PDFForm Control)

Fired once for each log message.

Syntax

Sub pdfformcontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. 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

Password Event (PDFForm Control)

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

Syntax

Sub pdfformcontrol_Password(Available As Boolean, Cancel As Boolean)

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 control or still needs to be set. If this parameter is set to , the correct password must be provided for the decryption attempt to succeed.

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

RecipientInfo Event (PDFForm Control)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

Sub pdfformcontrol_RecipientInfo(Issuer As String, SerialNumber As String, SubjectKeyIdentifier As String, Available As Boolean, Cancel As Boolean)

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 DecryptionCert 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 control or still needs to be set. If this parameter is set to , the correct certificate must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the control 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.

Config Settings (PDFForm Control)

PDFForm Config Settings

Base Config Settings

Trappable Errors (PDFForm Control)

PDFForm Errors

PDF Errors

Parsing Errors