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
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.
DecryptionCert | The decryption certificate. |
Fields | The entire collection of form fields contained in the document. |
Font | The currently set font. |
InputData | A byte array containing the PDF document to process. |
InputFile | The PDF file to process. |
OutputData | A byte array containing the PDF document after processing. |
OutputFile | The path to a local file where the output will be written. |
Overwrite | Whether or not the component should overwrite files. |
Password | The password to decrypt the document with. |
Position | The currently set position. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddBitmap | Adds a bitmap image to the document. |
AddButton | Adds a button field to the form. |
AddCaption | Adds a caption for a form field. |
AddCheckBox | Adds a check box field to the form. |
AddComboBox | Adds a combo box field to the form. |
AddDrawing | Adds a vector drawing to the document. |
AddListBox | Adds a list box field to the form. |
AddNewPage | Adds a new blank page to the document. |
AddRadioButton | Adds a radio button to the form. |
AddTextBox | Adds a text box field to the form. |
Close | Closes the opened document. |
Config | Sets or retrieves a configuration setting. |
CreateNew | Creates a new PDF document. |
Encrypted | Checks whether the document is encrypted. |
FindField | Locates a field in the document. |
Flatten | Flattens the form by removing the interactive form fields. |
GetFieldProperty | Returns the value of a field property. |
GetPageProperty | Returns the value of a page property. |
Open | Opens the document for processing. |
RemoveField | Removes a field from the document. |
RemoveFieldByName | Removes a field from the document. |
Reset | Resets the component. |
SetFieldProperty | Sets the value of a field property. |
SetFont | Sets the font properties to be applied to text. |
SetInputStream | Sets the stream containing the PDF document to process. |
SetOutputStream | Sets the stream to write the processed document to. |
SetPage | Sets the page to be used as the working page. |
SetPosition | Sets the position for form fields. |
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.
DocumentInfo | Fired when the document has been loaded into memory. |
Error | Fired when information is available about errors during data delivery. |
Log | Fired once for each log message. |
Password | Fired when the component detects that the document is encrypted with a password. |
RecipientInfo | Fired for each recipient certificate of the encrypted document. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AutoTurnPages | Whether to change the page automatically upon exceeding the upper or lower page boundary. |
CloseInputStreamAfterProcessing | Whether to close the input stream after processing. |
CloseOutputStreamAfterProcessing | Whether to close the output stream after processing. |
CompressStreams | Whether to compress stream objects. |
DefaultPageHeight | The default height for newly added pages. |
DefaultPageWidth | The default width for newly added pages. |
EnforcePDFA | Whether to enforce PDF/A compliance. |
FallbackFont | The fallback font. |
FontPaths | The font search paths. |
KeepPositionOnInsert | Whether to keep the current position after inserting an element. |
ListboxFlatten | The flattening mode for list box fields. |
LoadMedia | Whether to load images from the document. |
LogLevel | The level of detail that is logged. |
OptionsFormat | The format of the options in a combo box or list box field. |
OwnerPassword | The owner password to decrypt the document with. |
PDFALevel | The PDF/A conformance level to enforce. |
PDFAPolicy | The PDF/A policy to follow. |
RightPadding | The width of the whitespace gap to the right of newly added elements. |
SaveChanges | Whether to save changes made to the document. |
SystemFontNames | The system font names. |
TempPath | The location where temporary files are stored. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
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.
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 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:
Field property | Default value | Description |
AnnotationFlags | 0 | The field annotation flags. |
AnnotationHidden | False | Whether the field annotation is completely invisible, meaning it cannot be displayed, printed, or interacted with. |
AnnotationInvisible | False | Whether the field annotation is invisible on the screen and in print, but still remains interactive. |
AnnotationLocked | False | Whether the user cannot modify the field annotation's properties, such as its position and size. |
AnnotationLockedContents | False | Whether the user cannot modify the field annotation's contents. |
AnnotationNoRotate | False | Whether the field annotation's orientation remains fixed regardless of the page rotation. |
AnnotationNoView | False | Whether the field annotation is invisible on the screen and cannot be interacted with, but still appears when printed. |
AnnotationNoZoom | False | Whether the field annotation's size remains fixed regardless of the page magnification level. |
AnnotationPrint | False | Whether the field annotation will appear when the page is printed. |
AnnotationReadOnly | False | Whether the user cannot interact with or modify the field annotation. |
AnnotationToggleNoView | False | Whether the field annotation's NoView flag is intended to be toggled dynamically by a user action or script. |
Flags | 0 | The field flags. |
IncludeEdit | False | Whether the combo box field includes an editable text box in addition to a drop-down list. |
MultiLine | False | Whether the text box field can contain multiple lines of text. |
MultiSelect | False | Whether multiple Options can be selected simultaneously in the combo box or list box field. |
NoExport | False | Whether the field will not be exported when the form is submitted. |
NoToggleToOff | False | Whether exactly one radio button in the radio group must always be selected. |
Password | False | Whether the text box field is intended to contain a password. |
ReadOnly | False | Whether the user cannot change the field's Value. |
Required | False | Whether the field must have a Value before the form can be submitted. |
Sort | False | Whether the Options will be automatically sorted alphabetically in the combo box or list box field. |
UnisonSelect | False | Whether selecting one radio button automatically selects all other radio buttons in the same group that share the same FieldName and value for the on state. |
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:
Page property | Default value | Description |
CropLowerLeftX | 0 | The lower-left X coordinate of the page crop area in points. |
CropLowerLeftY | 0 | The lower-left Y coordinate of the page crop area in points. |
CropUpperRightX | 0 | The upper-right X coordinate of the page crop area in points. |
CropUpperRightY | 0 | The upper-right Y coordinate of the page crop area in points. |
Height | 0 | The height of the page in points. Both integer and decimal values are supported. |
MediaLowerLeftX | 0 | The lower-left X coordinate of the page media area in points. |
MediaLowerLeftY | 0 | The lower-left Y coordinate of the page media area in points. |
MediaUpperRightX | 0 | The upper-right X coordinate of the page media area in points. |
MediaUpperRightY | 0 | The upper-right Y coordinate of the page media area in points. |
Rotation | 0 | The rotation angle of the page in degrees. Possible values: 0, 90, 180, 270. |
Width | 0 | The width of the page in points. Both integer and decimal values are supported. |
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:
Field property | Default value | Description |
AnnotationFlags | 0 | The field annotation flags. |
AnnotationHidden | False | Whether the field annotation is completely invisible, meaning it cannot be displayed, printed, or interacted with. |
AnnotationInvisible | False | Whether the field annotation is invisible on the screen and in print, but still remains interactive. |
AnnotationLocked | False | Whether the user cannot modify the field annotation's properties, such as its position and size. |
AnnotationLockedContents | False | Whether the user cannot modify the field annotation's contents. |
AnnotationNoRotate | False | Whether the field annotation's orientation remains fixed regardless of the page rotation. |
AnnotationNoView | False | Whether the field annotation is invisible on the screen and cannot be interacted with, but still appears when printed. |
AnnotationNoZoom | False | Whether the field annotation's size remains fixed regardless of the page magnification level. |
AnnotationPrint | False | Whether the field annotation will appear when the page is printed. |
AnnotationReadOnly | False | Whether the user cannot interact with or modify the field annotation. |
AnnotationToggleNoView | False | Whether the field annotation's NoView flag is intended to be toggled dynamically by a user action or script. |
Flags | 0 | The field flags. |
IncludeEdit | False | Whether the combo box field includes an editable text box in addition to a drop-down list. |
MultiLine | False | Whether the text box field can contain multiple lines of text. |
MultiSelect | False | Whether multiple Options can be selected simultaneously in the combo box or list box field. |
NoExport | False | Whether the field will not be exported when the form is submitted. |
NoToggleToOff | False | Whether exactly one radio button in the radio group must always be selected. |
Password | False | Whether the text box field is intended to contain a password. |
ReadOnly | False | Whether the user cannot change the field's Value. |
Required | False | Whether the field must have a Value before the form can be submitted. |
Sort | False | Whether the Options will be automatically sorted alphabetically in the combo box or list box field. |
UnisonSelect | False | Whether selecting one radio button automatically selects all other radio buttons in the same group that share the same FieldName and value for the on state. |
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
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:
aliceblue | antiquewhite | aqua | aquamarine |
azure | beige | bisque | black |
blanchedalmond | blue | blueviolet | brown |
burlywood | cadetblue | chartreuse | chocolate |
coral | cornflowerblue | cornsilk | crimson |
cyan | darkblue | darkcyan | darkgoldenrod |
darkgray | darkgrey | darkgreen | darkkhaki |
darkmagenta | darkolivegreen | darkorange | darkorchid |
darkred | darksalmon | darkseagreen | darkslateblue |
darkslategray | darkslategrey | darkturquoise | darkviolet |
deeppink | deepskyblue | dimgray | dimgrey |
dodgerblue | firebrick | floralwhite | forestgreen |
fuchsia | gainsboro | ghostwhite | gold |
goldenrod | gray | grey | green |
greenyellow | honeydew | hotpink | indianred |
indigo | ivory | khaki | lavender |
lavenderblush | lawngreen | lemonchiffon | lightblue |
lightcoral | lightcyan | lightgoldenrodyellow | lightgray |
lightgrey | lightgreen | lightpink | lightsalmon |
lightseagreen | lightskyblue | lightslategray | lightslategrey |
lightsteelblue | lightyellow | lime | limegreen |
linen | magenta | maroon | mediumaquamarine |
mediumblue | mediumorchid | mediumpurple | mediumseagreen |
mediumslateblue | mediumspringgreen | mediumturquoise | mediumvioletred |
midnightblue | mintcream | mistyrose | moccasin |
navajowhite | navy | oldlace | olive |
olivedrab | orange | orangered | orchid |
palegoldenrod | palegreen | paleturquoise | palevioletred |
papayawhip | peachpuff | peru | pink |
plum | powderblue | purple | rebeccapurple |
red | rosybrown | royalblue | saddlebrown |
salmon | sandybrown | seagreen | seashell |
sienna | silver | skyblue | slateblue |
slategray | slategrey | snow | springgreen |
steelblue | tan | teal | thistle |
tomato | turquoise | violet | wheat |
white | whitesmoke | yellow | yellowgreen |
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:
0 (None) | No messages are logged. |
1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. |
2 (Verbose) | Detailed data such as HTTP requests are logged. |
3 (Debug) | Debug data including the full chain validation procedure are logged. |
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
EffectiveDate
String (read-only)
Default Value: ""
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.
ExpirationDate
String (read-only)
Default Value: ""
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.
ExtendedKeyUsage
String (read-only)
Default Value: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
String (read-only)
Default Value: ""
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
FingerprintSHA1
String (read-only)
Default Value: ""
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
FingerprintSHA256
String (read-only)
Default Value: ""
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
Issuer
String (read-only)
Default Value: ""
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
String (read-only)
Default Value: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
Boolean (read-only)
Default Value: False
Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
String (read-only)
Default Value: ""
The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
String (read-only)
Default Value: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
String (read-only)
Default Value: ""
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.
PublicKeyLength
Integer (read-only)
Default Value: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
String (read-only)
Default Value: ""
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.
SignatureAlgorithm
String (read-only)
Default Value: ""
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.
Store
String
Default Value: "MY"
The name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
TBytes
Default Value: "MY"
The name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
String
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
TispCertStoreTypes
Default Value: 0
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
String (read-only)
Default Value: ""
Comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
String (read-only)
Default Value: ""
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.
ThumbprintSHA1
String (read-only)
Default Value: ""
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.
ThumbprintSHA256
String (read-only)
Default Value: ""
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.
Usage
String (read-only)
Default Value: ""
The text description of UsageFlags.
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.
UsageFlags
Integer (read-only)
Default Value: 0
The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage property for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
String (read-only)
Default Value: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
String
Default Value: ""
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
String
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
TBytes
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
>
constructor Create();
Creates a instance whose properties can be set.
constructor Create(valEncoded: TBytes);
Parses Encoded as an X.509 public key.
constructor Create(valStoreType: TispCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
constructor Create(valStoreType: TispCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
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
Action
String
Default Value: ""
The JavaScript action assigned to the button field. This action will be executed if the button is pressed.
AltName
String
Default Value: ""
The alternate field name. This optional property contains a friendly name of the field, used when referring to the field in the user interface.
Caption
String
Default Value: ""
The caption of the button field.
DefaultValue
String
Default Value: ""
The default value of the form field.
FieldName
String
Default Value: ""
The local name of the field. This is normally a simple text string such as mybutton. See also FullName.
FieldType
Integer (read-only)
Default Value: 0
The type of the field.
Possible values are:
0 (Undefined - default) | |
1 (Button) | |
2 (Check box) | |
3 (Radio group) | |
4 (Radio button) | |
5 (Text box) | |
6 (List box) | |
7 (Combo box) | |
8 (Signature) |
FullName
String (read-only)
Default Value: ""
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.
Height
String
Default Value: "0"
The displayed height of the field in points. Both integer and decimal values are supported.
MaxLen
Integer
Default Value: 0
The maximum length of data that the text box can accept.
OffsetX
String
Default Value: "0"
The displayed offset of the field from the left-hand page border in points. Both integer and decimal values are supported.
OffsetY
String
Default Value: "0"
The displayed offset of the field from the bottom page border in points. Both integer and decimal values are supported.
Options
String
Default Value: ""
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.
PageIndex
Integer (read-only)
Default Value: -1
The page index containing the field.
Terminal
Boolean (read-only)
Default Value: True
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.
Value
String
Default Value: ""
The export value associated with the field. This contains the data that is the value of the field from the processor's standpoint.
Visible
Boolean
Default Value: False
Whether the field is visible or hidden.
Width
String
Default Value: "0"
The displayed width of the field in points. Both integer and decimal values are supported.
Constructors
constructor Create();
PDFFont Type
The font used in the PDF document.
Remarks
This type contains details about the font being applied to text.
Fields
Color
String (read-only)
Default Value: "#000000"
The color of the current font in hexadecimal format.
Name
String (read-only)
Default Value: "Arial"
The name of the current font.
Size
String (read-only)
Default Value: "12"
The size of the current font in points.
Style
String (read-only)
Default Value: ""
The style of the current font.
Constructors
constructor Create();
PDFPagePosition Type
The position within a PDF document.
Remarks
This type contains information about the current position on a page.
Fields
PageIndex
Integer (read-only)
Default Value: 0
The index of the current page in the PDF document.
X
String (read-only)
Default Value: "0"
The X coordinate of the current position on the page.
Y
String (read-only)
Default Value: "0"
The Y coordinate of the current position on the page.
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
Default | Keep the existing appearance of the object. This may cause some items further down the list to become hidden from view. |
ValueOnly | Print only the selected value of the list box. |
Full | Print all the items in the list box. This may cause the printed list box to take up more space than the original due to expansion of scrollbars. |
0 (None) | No messages are logged. |
1 (Info - default) | Informational events such as the basics of the chain validation procedure are logged. |
2 (Verbose) | Detailed data such as HTTP requests are logged. |
3 (Debug) | Debug data including the full chain validation procedure are logged. |
Default | Maps to NamesOnly. |
NamesOnly | Each line of the multi-line string contains the name of the element (e.g., Red\r\nGreen\r\nBlue). |
ValuesOnly | Each line of the multi-line string contains the export value of the element (e.g., 1\r\n2\r\n3). |
NamesAndValues | Each line of the multi-line string contains the name and export value of the element, separated with the | character (e.g., Red|1\r\nGreen|2\r\nBlue|3). |
NamesAndValues,X | Each line of the multi-line string contains the name and export value of the element, separated with the X string (e.g., Red==1\r\nGreen==2\r\nBlue==3 if set to NamesAndValues,==). |
1 | PDF/A-1. |
2 | PDF/A-2. |
3 (default) | PDF/A-3. |
Default | Maps to Preserve. |
Preserve | Keep existing document features and only write PDF/A-compliant pieces. If the component needs to write a non-compliant piece, it will throw an exception. |
Enforce | Preserve PDF/A-compliant pieces and attempt to fix violations in the original document. |
0 | Discard all changes. |
1 | Save the document to OutputFile, OutputData, or the stream set in SetOutputStream, even if it has not been modified. |
2 (default) | Save the document to OutputFile, OutputData, or the stream set in SetOutputStream, but only if it has been modified. |
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
Setting this configuration setting to True tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to False by default on all platforms.
Trappable Errors (PDFForm Component)
PDFForm Errors
1202 | Invalid field type. |
1203 | Page or field index is out of bounds. |
1206 | Invalid parent label. |
1207 | Cannot remove non-terminal field. |
1209 | Invalid PDF structure. |
PDF Errors
804 | PDF decompression failed. |
805 | Cannot add entry to cross-reference table. |
806 | Unsupported field size. |
807 | Unsupported Encoding filter. |
808 | Unsupported predictor algorithm. |
809 | Unsupported document version. |
812 | Cannot read PDF file stream. |
813 | Cannot write to PDF file stream. |
814 | OutputFile already exists and Overwrite is False. |
815 | Invalid parameter. |
817 | Bad cross-reference entry. |
818 | Invalid object or generation number. |
819 | Invalid object stream. |
820 | Invalid stream dictionary. |
821 | Invalid AcroForm entry. |
822 | Invalid Root entry. |
823 | Invalid annotation. |
824 | The input document is empty. |
826 | OpenType font error. The error description contains the detailed message. |
828 | Invalid CMS data. The error description contains the detailed message. |
835 | Cannot change decryption mode for opened document. |
836 | Unsupported Date string. |
838 | Cryptographic error. The error description contains the detailed message. |
840 | DecryptionCert error. The error description contains the detailed message. |
841 | Encryption failed. The error description contains the detailed message. |
842 | No proper certificate for encryption found. |
846 | Unsupported revision. |
847 | Unsupported security handler SubFilter. |
848 | Failed to verify permissions. |
849 | Invalid password. |
850 | Invalid password information. |
852 | Unsupported encryption algorithm. |
859 | Cannot encrypt encrypted document. |
864 | Cannot modify document after signature update. |
868 | Cannot encrypt or decrypt object. |
869 | Invalid security handler information. |
870 | Invalid encrypted data. |
871 | Invalid block cipher padding. |
872 | Failed to reload signature. |
873 | Object is not encrypted. |
874 | Unexpected cipher information. |
877 | Invalid document. Bad document catalog. |
878 | Invalid document Id. |
880 | Invalid document. Invalid requirements dictionary. |
881 | Invalid linearization dictionary. |
882 | Invalid signature information. |
883 | Unsupported document format. |
890 | Unsupported feature. |
891 | Internal error. The error description contains the detailed message. |
892 | Unsupported color. |
893 | This operation is not supported for this PDF/A level. |
894 | Interactive features (Action) are not supported by PDF/A. Set EnforcePDFA to False or clear the Action property of the field. |
895 | Font file not found. |
Parsing Errors
1001 | Bad object. |
1002 | Bad document trailer. |
1003 | Illegal stream dictionary. |
1004 | Illegal string. |
1005 | Indirect object expected. |
1007 | Invalid reference. |
1008 | Invalid reference table. |
1009 | Invalid stream data. |
1010 | Unexpected character. |
1011 | Unexpected EOF. |
1012 | Unexpected indirect object in cross-reference table. |
1013 | RDF object not found. |
1014 | Invalid RDF object. |
1015 | Cannot create element with unknown prefix. |
1021 | Invalid type in Root object list. |