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.

DecryptionCert Property (PDFForm Component)

The decryption certificate.

Syntax

property DecryptionCert: TispCertificate read get_DecryptionCert write set_DecryptionCert;

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

Fields Property (PDFForm Component)

The entire collection of form fields contained in the document.

Syntax

property Fields: TispPDFFieldList read get_Fields;

Remarks

This property is used to access individual form fields within the document.

The PDF specification allows for an advanced, tree-like structure of the form fields, with each field residing within that tree. Much like in the object-oriented approach, form fields inherit properties from the fields that are their immediate parents in the tree. The leaf fields, called "terminal" by the specification, are the actual fields available for filling in and submitting. The fields occupying intermediate tree nodes are abstract and are only there to define a set of their descendant fields.

The PDFForm component flattens the tree structure, presenting the fields as one linear list. The following mechanisms can be used to navigate the tree:

• Use the Terminal property to find out if the field is terminal/leaf and can be filled in.
• The FullName property contains the full name of the field in dotted format (parent.intermediate.child). Remove the last element from the name to obtain the name of the parent field (parent.intermediate in this case).
• Use the FindField method to easily locate the field in the Fields properties.

Use the AddButton, AddCheckBox, AddRadioButton, and similar methods to add new fields to the form. Then edit the properties of the PDFField objects published in the Fields properties to modify them.

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

Please refer to the PDFField type for a complete list of fields.

Font Property (PDFForm Component)

The currently set font.

Syntax

property Font: TispPDFFont read get_Font;

Remarks

This property is used to access the font details specified using the SetFont method.

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

Please refer to the PDFFont type for a complete list of fields.

InputData Property (PDFForm Component)

A byte array containing the PDF document to process.

Syntax

property InputData: TBytes read get_InputData write set_InputData;

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.

InputFile Property (PDFForm Component)

The PDF file to process.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

Default Value

''

Remarks

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

OutputData Property (PDFForm Component)

A byte array containing the PDF document after processing.

Syntax

property OutputData: TBytes read get_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.

OutputFile Property (PDFForm Component)

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

Syntax

property OutputFile: String read get_OutputFile write set_OutputFile;

Default Value

''

Remarks

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

Overwrite Property (PDFForm Component)

Whether or not the component should overwrite files.

Syntax

property Overwrite: Boolean read get_Overwrite write set_Overwrite;

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.

Password Property (PDFForm Component)

The password to decrypt the document with.

Syntax

property Password: String read get_Password write set_Password;

Default Value

''

Remarks

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

Position Property (PDFForm Component)

The currently set position.

Syntax

property Position: TispPDFPagePosition read get_Position;

Remarks

This property is used to access the position details specified using the SetPosition and SetPage methods.

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

Please refer to the PDFPagePosition type for a complete list of fields.

AddBitmap Method (PDFForm Component)

Adds a bitmap image to the document.

Syntax

procedure AddBitmap(Format: String; BitmapBytes: TBytes; BitmapWidth: Integer; BitmapHeight: Integer; ScaleX: String; ScaleY: String);

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

function AddButton(Name: String; Caption: String): Integer;

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

procedure AddCaption(Caption: String);

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

function AddCheckBox(Name: String; DefaultValue: Boolean): Integer;

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

function AddComboBox(Name: String; Options: String; DefaultValue: String): Integer;

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

procedure AddDrawing(Format: String; DrawingBytes: TBytes; ScaleX: String; ScaleY: String);

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

function AddListBox(Name: String; Options: String; DefaultValue: String): Integer;

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

procedure AddNewPage(PageIndex: Integer);

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

function AddRadioButton(RadioGroup: String; Name: String; IsDefaultButton: Boolean): Integer;

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 DefaultValue 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

function AddTextBox(Name: String; DefaultValue: String; Password: Boolean): Integer;

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

procedure 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

function Config(ConfigurationString: String): String;

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

procedure 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

function Encrypted(): Boolean;

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

function FindField(Name: String): Integer;

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

procedure 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

function GetFieldProperty(FieldIndex: Integer; FieldProperty: String): String;

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

function GetPageProperty(PageIndex: Integer; PageProperty: String): String;

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

procedure 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

procedure RemoveField(Index: Integer);

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

procedure RemoveFieldByName(Name: String);

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

procedure 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

procedure SetFieldProperty(FieldIndex: Integer; FieldProperty: String; Value: String);

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

procedure SetFont(Name: String; Size: String; Style: String; Color: String);

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:

SetInputStream Method (PDFForm Component)

Sets the stream containing the PDF document to process.

Syntax

procedure SetInputStream(InputStream: TStream);

Remarks

This method is used to set the stream from which the component will read the PDF document to be processed. If an input stream is set before the component attempts to perform operations on the document, the component will read the data from the input stream instead of from the InputFile or InputData properties.

NOTE: It may be useful to additionally set the CloseInputStreamAfterProcessing configuration setting to True when using input streams.

SetOutputStream Method (PDFForm Component)

Sets the stream to write the processed document to.

Syntax

procedure SetOutputStream(OutputStream: TStream);

Remarks

This method is used to set the stream to which the component will write the resulting PDF document. If an output stream is set before the component attempts to perform operations on the document, the component will write the data to the output stream instead of writing to OutputFile or populating OutputData.

NOTE: It may be useful to additionally set the CloseOutputStreamAfterProcessing configuration setting to True when using output streams.

SetPage Method (PDFForm Component)

Sets the page to be used as the working page.

Syntax

procedure SetPage(PageIndex: Integer);

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

procedure SetPosition(X: String; Y: String);

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

type TDocumentInfoEvent = procedure (
  Sender: TObject;
  PageCount: Integer;
  SignatureCount: Integer
) of Object;

property OnDocumentInfo: TDocumentInfoEvent 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

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent 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

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent 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

type TPasswordEvent = procedure (
  Sender: TObject;
  Available: Boolean;
  var Cancel: Boolean
) of Object;

property OnPassword: TPasswordEvent 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

type TRecipientInfoEvent = procedure (
  Sender: TObject;
  const Issuer: String;
  const SerialNumber: String;
  const SubjectKeyIdentifier: String;
  Available: Boolean;
  var Cancel: Boolean
) of Object;

property OnRecipientInfo: TRecipientInfoEvent 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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

>

constructor Create();

>

constructor Create(valEncoded: TBytes);

>

constructor Create(valStoreType: TispCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

>

constructor Create(valStoreType: TispCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

PDFField Type

A single form field.

Remarks

This type provides access to the properties of an individual field object.

• Action
• AltName
• Caption
• DefaultValue
• FieldName
• FieldType
• FullName
• Height
• MaxLen
• OffsetX
• OffsetY
• Options
• PageIndex
• Terminal
• Value
• Visible
• Width

Fields

Constructors

constructor Create();

PDFFont Type

The font used in the PDF document.

Remarks

This type contains details about the font being applied to text.

• Color
• Name
• Size
• Style

Fields

Constructors

constructor Create();

PDFPagePosition Type

The position within a PDF document.

Remarks

This type contains information about the current position on a page.

• PageIndex
• X
• Y

Fields

Constructors

constructor Create();

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