PDFForm Component

Properties   Methods   Events   Config Settings   Errors  

The PDFForm component offers PDF form management capabilities.

Syntax

TispPDFForm

Remarks

The PDF specification defines seven interactive form field types:

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

The PDFForm component supports the creation and modification of all the above field types in a PDF document (except for signature fields, which are covered by the PDFSign component - please see this article for more details).

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

The below sections contain instructions for adding and modifying each type of form field. Note that each of the following methods returns the index of the newly added field in the Fields properties, making it easy to access the PDFField object later. These objects' properties, such as their current values and dimensions, can then be adjusted to ensure the form meets your requirements.

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: int buttonIdx = pdfform.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. pdfform.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: int checkBoxIdx = pdfform.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. pdfform.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: int radioButtonIdx = pdfform.AddRadioButton("radioGroup", "radiobutton", false); int radioButton2Idx = pdfform.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. pdfform.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: int textBoxIdx = pdfform.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. pdfform.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: int listBoxIdx = pdfform.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". pdfform.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: int comboBoxIdx = pdfform.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". pdfform.Fields[comboBoxIdx].Value = "Blue";

Removing Form Fields

The RemoveField and RemoveFieldByName methods can be used to remove a form field from the document. These methods will not only deactivate the field on the form but will also remove the corresponding PDFField object from the Fields properties.

RemoveField removes a form field identified by its index, whereas RemoveFieldByName removes a field by using its name. pdfform.RemoveField(buttonIdx); pdfform.RemoveFieldByName("checkbox");

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

DecryptionCertEffectiveDate Property (PDFForm Component)

The date on which this certificate becomes valid.

Syntax

__property String DecryptionCertEffectiveDate = { read=FDecryptionCertEffectiveDate };

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 Component)

The date on which the certificate expires.

Syntax

__property String DecryptionCertExpirationDate = { read=FDecryptionCertExpirationDate };

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 Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String DecryptionCertExtendedKeyUsage = { read=FDecryptionCertExtendedKeyUsage };

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 Component)

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

Syntax

__property String DecryptionCertFingerprint = { read=FDecryptionCertFingerprint };

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 Component)

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

Syntax

__property String DecryptionCertFingerprintSHA1 = { read=FDecryptionCertFingerprintSHA1 };

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 Component)

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

Syntax

__property String DecryptionCertFingerprintSHA256 = { read=FDecryptionCertFingerprintSHA256 };

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 Component)

The issuer of the certificate.

Syntax

__property String DecryptionCertIssuer = { read=FDecryptionCertIssuer };

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 Component)

The private key of the certificate (if available).

Syntax

__property String DecryptionCertPrivateKey = { read=FDecryptionCertPrivateKey };

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 Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool DecryptionCertPrivateKeyAvailable = { read=FDecryptionCertPrivateKeyAvailable };

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 Component)

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

Syntax

__property String DecryptionCertPrivateKeyContainer = { read=FDecryptionCertPrivateKeyContainer };

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 Component)

The public key of the certificate.

Syntax

__property String DecryptionCertPublicKey = { read=FDecryptionCertPublicKey };

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 Component)

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

Syntax

__property String DecryptionCertPublicKeyAlgorithm = { read=FDecryptionCertPublicKeyAlgorithm };

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 Component)

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

Syntax

__property int DecryptionCertPublicKeyLength = { read=FDecryptionCertPublicKeyLength };

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 Component)

The serial number of the certificate encoded as a string.

Syntax

__property String DecryptionCertSerialNumber = { read=FDecryptionCertSerialNumber };

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 Component)

The text description of the certificate's signature algorithm.

Syntax

__property String DecryptionCertSignatureAlgorithm = { read=FDecryptionCertSignatureAlgorithm };

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 Component)

The name of the certificate store for the client certificate.

Syntax

__property String DecryptionCertStore = { read=FDecryptionCertStore, write=FSetDecryptionCertStore };
__property DynamicArray<Byte> DecryptionCertStoreB = { read=FDecryptionCertStoreB, write=FSetDecryptionCertStoreB };

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

This property is not available at design time.

Data Type

Byte Array

DecryptionCertStorePassword Property (PDFForm Component)

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

Syntax

__property String DecryptionCertStorePassword = { read=FDecryptionCertStorePassword, write=FSetDecryptionCertStorePassword };

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 Component)

The type of certificate store for this certificate.

Syntax

__property TispPDFFormDecryptionCertStoreTypes DecryptionCertStoreType = { read=FDecryptionCertStoreType, write=FSetDecryptionCertStoreType };

enum TispPDFFormDecryptionCertStoreTypes {
  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

cstUser

Remarks

The type of certificate store for this certificate.

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

This property is not available at design time.

Data Type

Integer

DecryptionCertSubjectAltNames Property (PDFForm Component)

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

Syntax

__property String DecryptionCertSubjectAltNames = { read=FDecryptionCertSubjectAltNames };

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 Component)

The MD5 hash of the certificate.

Syntax

__property String DecryptionCertThumbprintMD5 = { read=FDecryptionCertThumbprintMD5 };

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 Component)

The SHA-1 hash of the certificate.

Syntax

__property String DecryptionCertThumbprintSHA1 = { read=FDecryptionCertThumbprintSHA1 };

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 Component)

The SHA-256 hash of the certificate.

Syntax

__property String DecryptionCertThumbprintSHA256 = { read=FDecryptionCertThumbprintSHA256 };

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 Component)

The text description of UsageFlags .

Syntax

__property String DecryptionCertUsage = { read=FDecryptionCertUsage };

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 Component)

The flags that show intended use for the certificate.

Syntax

__property int DecryptionCertUsageFlags = { read=FDecryptionCertUsageFlags };

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 Component)

The certificate's version number.

Syntax

__property String DecryptionCertVersion = { read=FDecryptionCertVersion };

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 Component)

The subject of the certificate used for client authentication.

Syntax

__property String DecryptionCertSubject = { read=FDecryptionCertSubject, write=FSetDecryptionCertSubject };

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 Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String DecryptionCertEncoded = { read=FDecryptionCertEncoded, write=FSetDecryptionCertEncoded };
__property DynamicArray<Byte> DecryptionCertEncodedB = { read=FDecryptionCertEncodedB, write=FSetDecryptionCertEncodedB };

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.

This property is not available at design time.

Data Type

Byte Array

FieldCount Property (PDFForm Component)

The number of records in the Field arrays.

Syntax

__property int FieldCount = { read=FFieldCount };

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 Component)

The JavaScript action assigned to the button property.

Syntax

__property String FieldAction[int FieldIndex] = { read=FFieldAction, write=FSetFieldAction };

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 Component)

The alternate property name.

Syntax

__property String FieldAltName[int FieldIndex] = { read=FFieldAltName, write=FSetFieldAltName };

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 Component)

The caption of the button property.

Syntax

__property String FieldCaption[int FieldIndex] = { read=FFieldCaption, write=FSetFieldCaption };

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 Component)

The default value of the form property.

Syntax

__property String FieldDefaultValue[int FieldIndex] = { read=FFieldDefaultValue, write=FSetFieldDefaultValue };

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 Component)

The local name of the property.

Syntax

__property String FieldName[int FieldIndex] = { read=FFieldName, write=FSetFieldName };

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 Component)

The type of the property.

Syntax

__property int FieldType[int FieldIndex] = { read=FFieldType };

Default Value

0

Remarks

The type of the field.

Possible values are:

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 Component)

The full name of the property.

Syntax

__property String FieldFullName[int FieldIndex] = { read=FFieldFullName };

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 Component)

The displayed height of the property in points.

Syntax

__property String FieldHeight[int FieldIndex] = { read=FFieldHeight, write=FSetFieldHeight };

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 Component)

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

Syntax

__property int FieldMaxLen[int FieldIndex] = { read=FFieldMaxLen, write=FSetFieldMaxLen };

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 Component)

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

Syntax

__property String FieldOffsetX[int FieldIndex] = { read=FFieldOffsetX, write=FSetFieldOffsetX };

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 Component)

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

Syntax

__property String FieldOffsetY[int FieldIndex] = { read=FFieldOffsetY, write=FSetFieldOffsetY };

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 Component)

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

Syntax

__property String FieldOptions[int FieldIndex] = { read=FFieldOptions, write=FSetFieldOptions };

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 Component)

The page index containing the property.

Syntax

__property int FieldPageIndex[int FieldIndex] = { read=FFieldPageIndex };

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 Component)

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

Syntax

__property bool FieldTerminal[int FieldIndex] = { read=FFieldTerminal };

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 Component)

The export value associated with the property.

Syntax

__property String FieldValue[int FieldIndex] = { read=FFieldValue, write=FSetFieldValue };

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 Component)

Whether the property is visible or hidden.

Syntax

__property bool FieldVisible[int FieldIndex] = { read=FFieldVisible, write=FSetFieldVisible };

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 Component)

The displayed width of the property in points.

Syntax

__property String FieldWidth[int FieldIndex] = { read=FFieldWidth, write=FSetFieldWidth };

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 Component)

The color of the current font in hexadecimal format.

Syntax

__property String FontColor = { read=FFontColor };

Default Value

"#000000"

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 Component)

The name of the current font.

Syntax

__property String FontName = { read=FFontName };

Default Value

"Arial"

Remarks

The name of the current font.

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

Data Type

String

FontSize Property (PDFForm Component)

The size of the current font in points.

Syntax

__property String FontSize = { read=FFontSize };

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 Component)

The style of the current font.

Syntax

__property String FontStyle = { read=FFontStyle };

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 Component)

A byte array containing the PDF document to process.

Syntax

__property DynamicArray InputData = { read=FInputData, write=FSetInputData };

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 Component)

The PDF file to process.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

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

Data Type

String

OutputData Property (PDFForm Component)

A byte array containing the PDF document after processing.

Syntax

__property DynamicArray OutputData = { read=FOutputData };

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 Component)

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

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

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 Component)

Whether or not the component should overwrite files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

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

Data Type

Boolean

Password Property (PDFForm Component)

The password to decrypt the document with.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

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 Component)

The index of the current page in the PDF document.

Syntax

__property int PositionPageIndex = { read=FPositionPageIndex };

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 Component)

The X coordinate of the current position on the page.

Syntax

__property String PositionX = { read=FPositionX };

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 Component)

The Y coordinate of the current position on the page.

Syntax

__property String PositionY = { read=FPositionY };

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 Component)

Adds a bitmap image to the document.

Syntax

void __fastcall AddBitmap(String Format, DynamicArray<Byte> BitmapBytes, int BitmapWidth, int BitmapHeight, String ScaleX, String ScaleY);

Remarks

This method is used to add a bitmap image to the document at the current Position.

The Format and BitmapBytes parameters specify the format and raw data of the serialized image respectively. The former can take one of the following values:

• JPEG2000
• JPEG
• Custom

The BitmapWidth and BitmapHeight parameters specify the original width and height of the bitmap in pixels.

The ScaleX and ScaleY parameters specify the horizontal and vertical scaling of the bitmap as real values, with 1.0 being the actual size of the bitmap (100%).

AddButton Method (PDFForm Component)

Adds a button field to the form.

Syntax

int __fastcall AddButton(String Name, String Caption);

Remarks

This method is used to create a button field with name Name and caption Caption at the current 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 Component)

Adds a caption for a form field.

Syntax

void __fastcall AddCaption(String Caption);

Remarks

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

AddCheckBox Method (PDFForm Component)

Adds a check box field to the form.

Syntax

int __fastcall AddCheckBox(String Name, bool DefaultValue);

Remarks

This method is used to create a check box field with name Name at the current 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 Component)

Adds a combo box field to the form.

Syntax

int __fastcall AddComboBox(String Name, String Options, String DefaultValue);

Remarks

This method is used to create a combo box field with name Name at the current 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 Component)

Adds a vector drawing to the document.

Syntax

void __fastcall AddDrawing(String Format, DynamicArray<Byte> DrawingBytes, String ScaleX, String ScaleY);

Remarks

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

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

The ScaleX and ScaleY parameters specify the horizontal and vertical scaling of the drawing as real values, with 1.0 being the actual size of the drawing (100%).

AddListBox Method (PDFForm Component)

Adds a list box field to the form.

Syntax

int __fastcall AddListBox(String Name, String Options, String DefaultValue);

Remarks

This method is used to create a list box field with name Name at the current 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 Component)

Adds a new blank page to the document.

Syntax

void __fastcall AddNewPage(int PageIndex);

Remarks

This method is used to add a new page to the document at the position specified by the PageIndex parameter. Use the DefaultPageWidth and DefaultPageHeight configuration settings to adjust the new page dimensions.

Note that when this method returns, the Position will not be automatically moved to the newly added page.

AddRadioButton Method (PDFForm Component)

Adds a radio button to the form.

Syntax

int __fastcall AddRadioButton(String RadioGroup, String Name, bool IsDefaultButton);

Remarks

This method is used to create a radio button field with name Name, within the radio group RadioGroup, at the current 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 Component)

Adds a text box field to the form.

Syntax

int __fastcall AddTextBox(String Name, String DefaultValue, bool Password);

Remarks

This method is used to create a text box field with name Name at the current 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 (PDFForm Component)

Closes the opened document.

Syntax

void __fastcall Close();

Remarks

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

Example: 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 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

Creates a new PDF document.

Syntax

void __fastcall CreateNew();

Remarks

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

Encrypted Method (PDFForm Component)

Checks whether the document is encrypted.

Syntax

bool __fastcall Encrypted();

Remarks

This method is used to determine whether or not the document is encrypted. It will return false if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

FindField Method (PDFForm Component)

Locates a field in the document.

Syntax

int __fastcall FindField(String 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 Component)

Flattens the form by removing the interactive form fields.

Syntax

void __fastcall 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 Component)

Returns the value of a field property.

Syntax

String __fastcall GetFieldProperty(int FieldIndex, String FieldProperty);

Remarks

This method is used to obtain 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 Component)

Returns the value of a page property.

Syntax

String __fastcall GetPageProperty(int PageIndex, String PageProperty);

Remarks

This method is used to obtain general information about the pages of the document, 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: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); NOTE: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

Open Method (PDFForm Component)

Opens the document for processing.

Syntax

void __fastcall 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 Component)

Removes a field from the document.

Syntax

void __fastcall RemoveField(int 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 Component)

Removes a field from the document.

Syntax

void __fastcall RemoveFieldByName(String 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 Component)

Resets the component.

Syntax

void __fastcall Reset();

Remarks

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

SetFieldProperty Method (PDFForm Component)

Sets the value of a field property.

Syntax

void __fastcall SetFieldProperty(int FieldIndex, String FieldProperty, String 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 Component)

Sets the font properties to be applied to text.

Syntax

void __fastcall SetFont(String Name, String Size, String Style, String Color);

Remarks

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

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. The following syntax is supported:

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

For example:

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

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

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

SetPage Method (PDFForm Component)

Sets the page to be used as the working page.

Syntax

void __fastcall SetPage(int 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 Component)

Sets the position for form fields.

Syntax

void __fastcall SetPosition(String X, String 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: // Sets to exact coordinates. pdfform.SetPosition("100", "20"); // Moves 20 points to the right and 20 points down from the current position. pdfform.SetPosition("{x}+20", "{y}-20"); // Moves 20 points from the right edge and 120 points from the top edge of the page. pdfform.SetPosition("{width}-20", "{height}-120");

DocumentInfo Event (PDFForm Component)

Fired when the document has been loaded into memory.

Syntax

typedef struct {
  int PageCount;
  int SignatureCount;
} TispPDFFormDocumentInfoEventParams;
typedef void __fastcall (__closure *TispPDFFormDocumentInfoEvent)(System::TObject* Sender, TispPDFFormDocumentInfoEventParams *e);
__property TispPDFFormDocumentInfoEvent OnDocumentInfo = { read=FOnDocumentInfo, write=FOnDocumentInfo };

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 Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TispPDFFormErrorEventParams;
typedef void __fastcall (__closure *TispPDFFormErrorEvent)(System::TObject* Sender, TispPDFFormErrorEventParams *e);
__property TispPDFFormErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 Component)

Fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TispPDFFormLogEventParams;
typedef void __fastcall (__closure *TispPDFFormLogEvent)(System::TObject* Sender, TispPDFFormLogEventParams *e);
__property TispPDFFormLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

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

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

Syntax

typedef struct {
  bool Available;
  bool Cancel;
} TispPDFFormPasswordEventParams;
typedef void __fastcall (__closure *TispPDFFormPasswordEvent)(System::TObject* Sender, TispPDFFormPasswordEventParams *e);
__property TispPDFFormPasswordEvent OnPassword = { read=FOnPassword, write=FOnPassword };

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

RecipientInfo Event (PDFForm Component)

Fired for each recipient certificate of the encrypted document.

Syntax

typedef struct {
  String Issuer;
  String SerialNumber;
  String SubjectKeyIdentifier;
  bool Available;
  bool Cancel;
} TispPDFFormRecipientInfoEventParams;
typedef void __fastcall (__closure *TispPDFFormRecipientInfoEvent)(System::TObject* Sender, TispPDFFormRecipientInfoEventParams *e);
__property TispPDFFormRecipientInfoEvent OnRecipientInfo = { read=FOnRecipientInfo, write=FOnRecipientInfo };

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 component 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 component 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 Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PDFForm Config Settings

Base Config Settings

Trappable Errors (PDFForm Component)

PDFForm Errors

PDF Errors

Parsing Errors