# PDFForm Class The PDFForm class offers PDF form management capabilities. ## Class Name **SecurePDF_PDFForm** ## Procedural Interface ```text securepdf_pdfform_open(); securepdf_pdfform_close($res); securepdf_pdfform_register_callback($res, $id, $function); securepdf_pdfform_get_last_error($res); securepdf_pdfform_get_last_error_code($res); securepdf_pdfform_set($res, $id, $index, $value); securepdf_pdfform_get($res, $id, $index); securepdf_pdfform_do_addbitmap($res, $format, $bitmapbytes, $bitmapwidth, $bitmapheight, $scalex, $scaley); securepdf_pdfform_do_addbutton($res, $name, $caption); securepdf_pdfform_do_addcaption($res, $caption); securepdf_pdfform_do_addcheckbox($res, $name, $defaultvalue); securepdf_pdfform_do_addcombobox($res, $name, $options, $defaultvalue); securepdf_pdfform_do_adddrawing($res, $format, $drawingbytes, $scalex, $scaley); securepdf_pdfform_do_addlistbox($res, $name, $options, $defaultvalue); securepdf_pdfform_do_addnewpage($res, $pageindex); securepdf_pdfform_do_addradiobutton($res, $radiogroup, $name, $isdefaultbutton); securepdf_pdfform_do_addtextbox($res, $name, $defaultvalue, $password); securepdf_pdfform_do_close($res); securepdf_pdfform_do_config($res, $configurationstring); securepdf_pdfform_do_createnew($res); securepdf_pdfform_do_encrypted($res); securepdf_pdfform_do_findfield($res, $name); securepdf_pdfform_do_flatten($res); securepdf_pdfform_do_getfieldproperty($res, $fieldindex, $fieldproperty); securepdf_pdfform_do_getpageproperty($res, $pageindex, $pageproperty); securepdf_pdfform_do_open($res); securepdf_pdfform_do_removefield($res, $index); securepdf_pdfform_do_removefieldbyname($res, $name); securepdf_pdfform_do_reset($res); securepdf_pdfform_do_setfieldproperty($res, $fieldindex, $fieldproperty, $value); securepdf_pdfform_do_setfont($res, $name, $size, $style, $color); securepdf_pdfform_do_setposition($res, $pageindex, $x, $y); ``` ## Remarks The PDF specification defines seven interactive form field types: - Button - Checkbox - Radio button - Text box - List box - Combo box - Signature The PDFForm class 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 class - please see [this article](https://www.nsoftware.com/kb/articles/securepdf-empty-signature-fields) for more details). To begin, provide the input document as a file ([InputFile](#inputfile-property-securepdf_pdfform-class)), byte array ([InputData](#inputdata-property-securepdf_pdfform-class)), or stream (SetInputStream) and call [Open](#open-method-securepdf_pdfform-class). This method populates the Fields properties with the existing form fields in the document. When finished editing the form, call [Close](#close-method-securepdf_pdfform-class) to close the document and save the changes to either [OutputFile](#outputfile-property-securepdf_pdfform-class), [OutputData](#outputdata-property-securepdf_pdfform-class), 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 collection, 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. [SetPosition](#setposition-method-securepdf_pdfform-class) can be used to specify the form field's location (the page on which it is added and its position on the page). If [SetPosition](#setposition-method-securepdf_pdfform-class) is not explicitly called, the field is placed on the first page of the document by default. [SetFont](#setfont-method-securepdf_pdfform-class) 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](#addbutton-method-securepdf_pdfform-class) method to add a button field: ```csharp 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. ```csharp pdfform.Fields[buttonIdx].Action = "app.alert('Hello! This is a simple alert message.');"; ``` **Checkbox Fields** A checkbox represents a form field that can be toggled between two states: on and off. Use the [AddCheckBox](#addcheckbox-method-securepdf_pdfform-class) method to add a checkbox field: ```csharp int checkBoxIdx = pdfform.AddCheckBox("checkbox", false); ``` The value associated with a checkbox field determines whether it is toggled on or off. The example below toggles the checkbox on. ```csharp pdfform.Fields[checkBoxIdx].Value = "true"; ``` **Radio Button Fields** Radio button fields are a set of related buttons, each of which - just like checkboxes - 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](#addradiobutton-method-securepdf_pdfform-class) method to add a radio button field: ```csharp 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. ```csharp 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](#addtextbox-method-securepdf_pdfform-class) method to add a text box field: ```csharp 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. ```csharp 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](#addlistbox-method-securepdf_pdfform-class) method to add a list box field: ```csharp 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". ```csharp 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](#addcombobox-method-securepdf_pdfform-class) method to add a combo box field: ```csharp 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". ```csharp pdfform.Fields[comboBoxIdx].Value = "Blue"; ``` ### Removing Form Fields The [RemoveField](#removefield-method-securepdf_pdfform-class) and [RemoveFieldByName](#removefieldbyname-method-securepdf_pdfform-class) methods can be used to remove a form field from the document. These methods not only deactivate the field on the form but also remove the corresponding PDFField object from the Fields collection. [RemoveField](#removefield-method-securepdf_pdfform-class) removes a form field identified by its index, whereas [RemoveFieldByName](#removefieldbyname-method-securepdf_pdfform-class) removes a field by using its name. ```csharp pdfform.RemoveField(buttonIdx); pdfform.RemoveFieldByName("checkbox"); ``` ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DecryptionCertEffectiveDate](#decryptioncerteffectivedate-property-securepdf_pdfform-class) | The date on which this certificate becomes valid. | | [DecryptionCertExpirationDate](#decryptioncertexpirationdate-property-securepdf_pdfform-class) | The date on which the certificate expires. | | [DecryptionCertExtendedKeyUsage](#decryptioncertextendedkeyusage-property-securepdf_pdfform-class) | A comma-delimited list of extended key usage identifiers. | | [DecryptionCertFingerprint](#decryptioncertfingerprint-property-securepdf_pdfform-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [DecryptionCertFingerprintSHA1](#decryptioncertfingerprintsha1-property-securepdf_pdfform-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [DecryptionCertFingerprintSHA256](#decryptioncertfingerprintsha256-property-securepdf_pdfform-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [DecryptionCertIssuer](#decryptioncertissuer-property-securepdf_pdfform-class) | The issuer of the certificate. | | [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfform-class) | The private key of the certificate (if available). | | [DecryptionCertPrivateKeyAvailable](#decryptioncertprivatekeyavailable-property-securepdf_pdfform-class) | Whether a PrivateKey is available for the selected certificate. | | [DecryptionCertPrivateKeyContainer](#decryptioncertprivatekeycontainer-property-securepdf_pdfform-class) | The name of the PrivateKey container for the certificate (if available). | | [DecryptionCertPublicKey](#decryptioncertpublickey-property-securepdf_pdfform-class) | The public key of the certificate. | | [DecryptionCertPublicKeyAlgorithm](#decryptioncertpublickeyalgorithm-property-securepdf_pdfform-class) | The textual description of the certificate's public key algorithm. | | [DecryptionCertPublicKeyLength](#decryptioncertpublickeylength-property-securepdf_pdfform-class) | The length of the certificate's public key (in bits). | | [DecryptionCertSerialNumber](#decryptioncertserialnumber-property-securepdf_pdfform-class) | The serial number of the certificate encoded as a string. | | [DecryptionCertSignatureAlgorithm](#decryptioncertsignaturealgorithm-property-securepdf_pdfform-class) | The text description of the certificate's signature algorithm. | | [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class) | The name of the certificate store for the client certificate. | | [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfform-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [DecryptionCertStoreType](#decryptioncertstoretype-property-securepdf_pdfform-class) | The type of certificate store for this certificate. | | [DecryptionCertSubjectAltNames](#decryptioncertsubjectaltnames-property-securepdf_pdfform-class) | Comma-separated lists of alternative subject names for the certificate. | | [DecryptionCertThumbprintMD5](#decryptioncertthumbprintmd5-property-securepdf_pdfform-class) | The MD5 hash of the certificate. | | [DecryptionCertThumbprintSHA1](#decryptioncertthumbprintsha1-property-securepdf_pdfform-class) | The SHA-1 hash of the certificate. | | [DecryptionCertThumbprintSHA256](#decryptioncertthumbprintsha256-property-securepdf_pdfform-class) | The SHA-256 hash of the certificate. | | [DecryptionCertUsage](#decryptioncertusage-property-securepdf_pdfform-class) | The text description of UsageFlags . | | [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfform-class) | The flags that show intended use for the certificate. | | [DecryptionCertVersion](#decryptioncertversion-property-securepdf_pdfform-class) | The certificate's version number. | | [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfform-class) | The subject of the certificate used for client authentication. | | [DecryptionCertEncoded](#decryptioncertencoded-property-securepdf_pdfform-class) | The certificate (PEM/Base64 encoded). | | [FieldCount](#fieldcount-property-securepdf_pdfform-class) | The number of records in the Field arrays. | | [FieldAction](#fieldaction-property-securepdf_pdfform-class) | The JavaScript action assigned to the button property. | | [FieldAltName](#fieldaltname-property-securepdf_pdfform-class) | The alternate property name. | | [FieldCaption](#fieldcaption-property-securepdf_pdfform-class) | The caption of the button property. | | [FieldDefaultValue](#fielddefaultvalue-property-securepdf_pdfform-class) | The default value of the form property. | | [FieldName](#fieldname-property-securepdf_pdfform-class) | The local name of the property. | | [FieldType](#fieldtype-property-securepdf_pdfform-class) | The type of the property. | | [FieldFullName](#fieldfullname-property-securepdf_pdfform-class) | The full name of the property. | | [FieldHeight](#fieldheight-property-securepdf_pdfform-class) | The displayed height of the property in points. | | [FieldMaxLen](#fieldmaxlen-property-securepdf_pdfform-class) | The maximum length of data that the text box can accept. | | [FieldOffsetX](#fieldoffsetx-property-securepdf_pdfform-class) | The displayed offset of the property from the left-hand page border in points. | | [FieldOffsetY](#fieldoffsety-property-securepdf_pdfform-class) | The displayed offset of the property from the bottom page border in points. | | [FieldOptions](#fieldoptions-property-securepdf_pdfform-class) | The set of options offered by a combo box or list box property. | | [FieldPageIndex](#fieldpageindex-property-securepdf_pdfform-class) | The page index containing the property. | | [FieldTerminal](#fieldterminal-property-securepdf_pdfform-class) | Whether the property is terminal, meaning it is represented by a leaf entry in the property tree. | | [FieldValue](#fieldvalue-property-securepdf_pdfform-class) | The export value associated with the property. | | [FieldVisible](#fieldvisible-property-securepdf_pdfform-class) | Whether the property is visible or hidden. | | [FieldWidth](#fieldwidth-property-securepdf_pdfform-class) | The displayed width of the property in points. | | [FontColor](#fontcolor-property-securepdf_pdfform-class) | The color of the current font in hash-prefixed hexadecimal format or as a name. | | [FontName](#fontname-property-securepdf_pdfform-class) | The name of the current font. | | [FontSize](#fontsize-property-securepdf_pdfform-class) | The size of the current font in points. | | [FontStyle](#fontstyle-property-securepdf_pdfform-class) | The style of the current font. | | [InputData](#inputdata-property-securepdf_pdfform-class) | A byte array containing the PDF document to process. | | [InputFile](#inputfile-property-securepdf_pdfform-class) | The PDF file to process. | | [OutputData](#outputdata-property-securepdf_pdfform-class) | A byte array containing the PDF document after processing. | | [OutputFile](#outputfile-property-securepdf_pdfform-class) | The path to a local file where the output is written. | | [Overwrite](#overwrite-property-securepdf_pdfform-class) | Whether the class should overwrite files. | | [Password](#password-property-securepdf_pdfform-class) | The password to decrypt the document with. | | [PositionPageIndex](#positionpageindex-property-securepdf_pdfform-class) | The index of the current page in the PDF document. | | [PositionX](#positionx-property-securepdf_pdfform-class) | The X coordinate of the current position on the page. | | [PositionY](#positiony-property-securepdf_pdfform-class) | The Y coordinate of the current position on the page. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddBitmap](#addbitmap-method-securepdf_pdfform-class) | Adds a bitmap image to the document. | | [AddButton](#addbutton-method-securepdf_pdfform-class) | Adds a button field to the form. | | [AddCaption](#addcaption-method-securepdf_pdfform-class) | Adds a caption for a form field. | | [AddCheckBox](#addcheckbox-method-securepdf_pdfform-class) | Adds a checkbox field to the form. | | [AddComboBox](#addcombobox-method-securepdf_pdfform-class) | Adds a combo box field to the form. | | [AddDrawing](#adddrawing-method-securepdf_pdfform-class) | Adds a vector drawing to the document. | | [AddListBox](#addlistbox-method-securepdf_pdfform-class) | Adds a list box field to the form. | | [AddNewPage](#addnewpage-method-securepdf_pdfform-class) | Adds a new blank page to the document. | | [AddRadioButton](#addradiobutton-method-securepdf_pdfform-class) | Adds a radio button to the form. | | [AddTextBox](#addtextbox-method-securepdf_pdfform-class) | Adds a text box field to the form. | | [Close](#close-method-securepdf_pdfform-class) | Closes the opened document. | | [Config](#config-method-securepdf_pdfform-class) | Sets or retrieves a configuration setting. | | [CreateNew](#createnew-method-securepdf_pdfform-class) | Creates a new PDF document. | | [Encrypted](#encrypted-method-securepdf_pdfform-class) | Checks whether the document is encrypted. | | [FindField](#findfield-method-securepdf_pdfform-class) | Locates a field in the document. | | [Flatten](#flatten-method-securepdf_pdfform-class) | Flattens the form by removing the interactive form fields. | | [GetFieldProperty](#getfieldproperty-method-securepdf_pdfform-class) | Returns the value of a field property. | | [GetPageProperty](#getpageproperty-method-securepdf_pdfform-class) | Returns the value of a page property. | | [Open](#open-method-securepdf_pdfform-class) | Opens the document for processing. | | [RemoveField](#removefield-method-securepdf_pdfform-class) | Removes a field from the document. | | [RemoveFieldByName](#removefieldbyname-method-securepdf_pdfform-class) | Removes a field from the document. | | [Reset](#reset-method-securepdf_pdfform-class) | Resets the class. | | [SetFieldProperty](#setfieldproperty-method-securepdf_pdfform-class) | Sets the value of a field property. | | [SetFont](#setfont-method-securepdf_pdfform-class) | Sets the font properties to be applied to text. | | [SetPosition](#setposition-method-securepdf_pdfform-class) | Sets the page and position for new form fields, text blocks, or images. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DocumentInfo](#documentinfo-event-securepdf_pdfform-class) | Fired when the document has been loaded into memory. | | [Error](#error-event-securepdf_pdfform-class) | Fired when information is available about errors during data delivery. | | [Log](#log-event-securepdf_pdfform-class) | Fired once for each log message. | | [Password](#password-event-securepdf_pdfform-class) | Fired when the class detects that the document is encrypted with a password. | | [RecipientInfo](#recipientinfo-event-securepdf_pdfform-class) | Fired for each recipient certificate of the encrypted document. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AutoTurnPages](#AutoTurnPages) | Whether to change the page automatically upon exceeding the upper or lower page boundary. | | [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether to close the input stream after processing. | | [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Whether to close the output stream after processing. | | [CompressStreams](#CompressStreams) | Whether to compress stream objects. | | [DefaultPageHeight](#DefaultPageHeight) | The default height for newly added pages. | | [DefaultPageWidth](#DefaultPageWidth) | The default width for newly added pages. | | [EnforcePDFA](#EnforcePDFA) | Whether to enforce PDF/A compliance. | | [FallbackFont](#FallbackFont) | The fallback font. | | [FontPaths](#FontPaths) | The font search paths. | | [KeepPositionOnInsert](#KeepPositionOnInsert) | Whether to keep the current position after inserting an element. | | [ListboxFlatten](#ListboxFlatten) | The flattening mode for list box fields. | | [LoadMedia](#LoadMedia) | Whether to load images from the document. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [OptionsFormat](#OptionsFormat) | The format of the options in a combo box or list box field. | | [OwnerPassword](#OwnerPassword) | The owner password to decrypt the document with. | | [PDFALevel](#PDFALevel) | The PDF/A conformance level to enforce. | | [PDFAPolicy](#PDFAPolicy) | The PDF/A policy to follow. | | [RightPadding](#RightPadding) | The width of the whitespace gap to the right of newly added elements. | | [SaveChanges](#SaveChanges) | Whether to save changes made to the document. | | [SystemFontNames](#SystemFontNames) | The system font names. | | [TempPath](#TempPath) | The location where temporary files are stored. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # DecryptionCertEffectiveDate Property ([SecurePDF_PDFForm](#pdfform-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getDecryptionCertEffectiveDate(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 1 ); ``` ## Default Value '' ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only and not available at design time. ## Data Type String # DecryptionCertExpirationDate Property ([SecurePDF_PDFForm](#pdfform-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getDecryptionCertExpirationDate(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 2 ); ``` ## Default Value '' ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only and not available at design time. ## Data Type String # DecryptionCertExtendedKeyUsage Property ([SecurePDF_PDFForm](#pdfform-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getDecryptionCertExtendedKeyUsage(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 3 ); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only and not available at design time. ## Data Type String # DecryptionCertFingerprint Property ([SecurePDF_PDFForm](#pdfform-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertFingerprint(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 4 ); ``` ## Default Value '' ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only and not available at design time. ## Data Type String # DecryptionCertFingerprintSHA1 Property ([SecurePDF_PDFForm](#pdfform-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertFingerprintSHA1(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 5 ); ``` ## Default Value '' ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only and not available at design time. ## Data Type String # DecryptionCertFingerprintSHA256 Property ([SecurePDF_PDFForm](#pdfform-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertFingerprintSHA256(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 6 ); ``` ## Default Value '' ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only and not available at design time. ## Data Type String # DecryptionCertIssuer Property ([SecurePDF_PDFForm](#pdfform-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertIssuer(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 7 ); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPrivateKey Property ([SecurePDF_PDFForm](#pdfform-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getDecryptionCertPrivateKey(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 8 ); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfform-class) may be available but not exportable. In this case, [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfform-class) returns an empty string. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPrivateKeyAvailable Property ([SecurePDF_PDFForm](#pdfform-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getDecryptionCertPrivateKeyAvailable(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 9 ); ``` ## Default Value false ## Remarks Whether a [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfform-class) is available for the selected certificate. If [DecryptionCertPrivateKeyAvailable](#decryptioncertprivatekeyavailable-property-securepdf_pdfform-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only and not available at design time. ## Data Type Boolean # DecryptionCertPrivateKeyContainer Property ([SecurePDF_PDFForm](#pdfform-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getDecryptionCertPrivateKeyContainer(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 10 ); ``` ## Default Value '' ## Remarks The name of the [DecryptionCertPrivateKey](#decryptioncertprivatekey-property-securepdf_pdfform-class) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPublicKey Property ([SecurePDF_PDFForm](#pdfform-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertPublicKey(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 11 ); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPublicKeyAlgorithm Property ([SecurePDF_PDFForm](#pdfform-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getDecryptionCertPublicKeyAlgorithm(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 12 ); ``` ## Default Value '' ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only and not available at design time. ## Data Type String # DecryptionCertPublicKeyLength Property ([SecurePDF_PDFForm](#pdfform-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getDecryptionCertPublicKeyLength(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 13 ); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only and not available at design time. ## Data Type Integer # DecryptionCertSerialNumber Property ([SecurePDF_PDFForm](#pdfform-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getDecryptionCertSerialNumber(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 14 ); ``` ## Default Value '' ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only and not available at design time. ## Data Type String # DecryptionCertSignatureAlgorithm Property ([SecurePDF_PDFForm](#pdfform-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getDecryptionCertSignatureAlgorithm(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 15 ); ``` ## Default Value '' ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only and not available at design time. ## Data Type String # DecryptionCertStore Property ([SecurePDF_PDFForm](#pdfform-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getDecryptionCertStore(); public function setDecryptionCertStore($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 16 ); securepdf_pdfform_set($res, 16, $value ); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [DecryptionCertStoreType](#decryptioncertstoretype-property-securepdf_pdfform-class) property denotes the type of the certificate store specified by [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class). If the store is password-protected, specify the password in [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfform-class). [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class) is used in conjunction with the [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfform-class) property to specify client certificates. If [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class) has a value, and [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfform-class) or [DecryptionCertEncoded](#decryptioncertencoded-property-securepdf_pdfform-class) is set, a search for a certificate is initiated. Please see the [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfform-class) 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). This property is not available at design time. ## Data Type Binary String # DecryptionCertStorePassword Property ([SecurePDF_PDFForm](#pdfform-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getDecryptionCertStorePassword(); public function setDecryptionCertStorePassword($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 17 ); securepdf_pdfform_set($res, 17, $value ); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is not available at design time. ## Data Type String # DecryptionCertStoreType Property ([SecurePDF_PDFForm](#pdfform-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getDecryptionCertStoreType(); public function setDecryptionCertStoreType($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 18 ); securepdf_pdfform_set($res, 18, $value ); ``` ## Possible Values ```text PDFFORM_DECRYPTIONCERTSTORETYPE_USER(0), PDFFORM_DECRYPTIONCERTSTORETYPE_MACHINE(1), PDFFORM_DECRYPTIONCERTSTORETYPE_PFXFILE(2), PDFFORM_DECRYPTIONCERTSTORETYPE_PFXBLOB(3), PDFFORM_DECRYPTIONCERTSTORETYPE_JKSFILE(4), PDFFORM_DECRYPTIONCERTSTORETYPE_JKSBLOB(5), PDFFORM_DECRYPTIONCERTSTORETYPE_PEMKEY_FILE(6), PDFFORM_DECRYPTIONCERTSTORETYPE_PEMKEY_BLOB(7), PDFFORM_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_FILE(8), PDFFORM_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_BLOB(9), PDFFORM_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), PDFFORM_DECRYPTIONCERTSTORETYPE_P7BFILE(11), PDFFORM_DECRYPTIONCERTSTORETYPE_P7BBLOB(12), PDFFORM_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), PDFFORM_DECRYPTIONCERTSTORETYPE_PPKFILE(14), PDFFORM_DECRYPTIONCERTSTORETYPE_PPKBLOB(15), PDFFORM_DECRYPTIONCERTSTORETYPE_XMLFILE(16), PDFFORM_DECRYPTIONCERTSTORETYPE_XMLBLOB(17), PDFFORM_DECRYPTIONCERTSTORETYPE_JWKFILE(18), PDFFORM_DECRYPTIONCERTSTORETYPE_JWKBLOB(19), PDFFORM_DECRYPTIONCERTSTORETYPE_SECURITY_KEY(20), PDFFORM_DECRYPTIONCERTSTORETYPE_BCFKSFILE(21), PDFFORM_DECRYPTIONCERTSTORETYPE_BCFKSBLOB(22), PDFFORM_DECRYPTIONCERTSTORETYPE_PKCS11(23), PDFFORM_DECRYPTIONCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [DecryptionCertStoreType](#decryptioncertstoretype-property-securepdf_pdfform-class), the full path of the PKCS#11 DLL as the [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class), and the PIN as the [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfform-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class) and set [DecryptionCertStorePassword](#decryptioncertstorepassword-property-securepdf_pdfform-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | This property is not available at design time. ## Data Type Integer # DecryptionCertSubjectAltNames Property ([SecurePDF_PDFForm](#pdfform-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getDecryptionCertSubjectAltNames(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 19 ); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only and not available at design time. ## Data Type String # DecryptionCertThumbprintMD5 Property ([SecurePDF_PDFForm](#pdfform-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertThumbprintMD5(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 20 ); ``` ## Default Value '' ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only and not available at design time. ## Data Type String # DecryptionCertThumbprintSHA1 Property ([SecurePDF_PDFForm](#pdfform-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertThumbprintSHA1(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 21 ); ``` ## Default Value '' ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only and not available at design time. ## Data Type String # DecryptionCertThumbprintSHA256 Property ([SecurePDF_PDFForm](#pdfform-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getDecryptionCertThumbprintSHA256(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 22 ); ``` ## Default Value '' ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only and not available at design time. ## Data Type String # DecryptionCertUsage Property ([SecurePDF_PDFForm](#pdfform-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getDecryptionCertUsage(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 23 ); ``` ## Default Value '' ## Remarks The text description of [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfform-class). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only and not available at design time. ## Data Type String # DecryptionCertUsageFlags Property ([SecurePDF_PDFForm](#pdfform-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getDecryptionCertUsageFlags(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 24 ); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfform-class) 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 [DecryptionCertUsage](#decryptioncertusage-property-securepdf_pdfform-class) property for a text representation of [DecryptionCertUsageFlags](#decryptioncertusageflags-property-securepdf_pdfform-class). This functionality currently is not available when the provider is OpenSSL. This property is read-only and not available at design time. ## Data Type Integer # DecryptionCertVersion Property ([SecurePDF_PDFForm](#pdfform-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getDecryptionCertVersion(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 25 ); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only and not available at design time. ## Data Type String # DecryptionCertSubject Property ([SecurePDF_PDFForm](#pdfform-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getDecryptionCertSubject(); public function setDecryptionCertSubject($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 26 ); securepdf_pdfform_set($res, 26, $value ); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | 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. This property is not available at design time. ## Data Type String # DecryptionCertEncoded Property ([SecurePDF_PDFForm](#pdfform-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getDecryptionCertEncoded(); public function setDecryptionCertEncoded($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 27 ); securepdf_pdfform_set($res, 27, $value ); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class) and [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfform-class) properties also may be used to specify a certificate. When [DecryptionCertEncoded](#decryptioncertencoded-property-securepdf_pdfform-class) is set, a search is initiated in the current [DecryptionCertStore](#decryptioncertstore-property-securepdf_pdfform-class) for the private key of the certificate. If the key is found, [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfform-class) is updated to reflect the full subject of the selected certificate; otherwise, [DecryptionCertSubject](#decryptioncertsubject-property-securepdf_pdfform-class) is set to an empty string. This property is not available at design time. ## Data Type Binary String # FieldCount Property ([SecurePDF_PDFForm](#pdfform-class) Class) The number of records in the Field arrays. ## Object Oriented Interface ```text public function getFieldCount(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 28 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [FieldAction](#fieldaction-property-securepdf_pdfform-class) - [FieldAltName](#fieldaltname-property-securepdf_pdfform-class) - [FieldCaption](#fieldcaption-property-securepdf_pdfform-class) - [FieldDefaultValue](#fielddefaultvalue-property-securepdf_pdfform-class) - [FieldFullName](#fieldfullname-property-securepdf_pdfform-class) - [FieldHeight](#fieldheight-property-securepdf_pdfform-class) - [FieldMaxLen](#fieldmaxlen-property-securepdf_pdfform-class) - [FieldName](#fieldname-property-securepdf_pdfform-class) - [FieldOffsetX](#fieldoffsetx-property-securepdf_pdfform-class) - [FieldOffsetY](#fieldoffsety-property-securepdf_pdfform-class) - [FieldOptions](#fieldoptions-property-securepdf_pdfform-class) - [FieldPageIndex](#fieldpageindex-property-securepdf_pdfform-class) - [FieldTerminal](#fieldterminal-property-securepdf_pdfform-class) - [FieldType](#fieldtype-property-securepdf_pdfform-class) - [FieldValue](#fieldvalue-property-securepdf_pdfform-class) - [FieldVisible](#fieldvisible-property-securepdf_pdfform-class) - [FieldWidth](#fieldwidth-property-securepdf_pdfform-class) The array indices start at *0* and end at *FieldCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # FieldAction Property ([SecurePDF_PDFForm](#pdfform-class) Class) The JavaScript action assigned to the button property. ## Object Oriented Interface ```text public function getFieldAction($fieldindex); public function setFieldAction($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 29 , $fieldindex); securepdf_pdfform_set($res, 29, $value , $fieldindex); ``` ## Default Value '' ## Remarks The JavaScript action assigned to the button field. This action is executed if the button is pressed. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldAltName Property ([SecurePDF_PDFForm](#pdfform-class) Class) The alternate property name. ## Object Oriented Interface ```text public function getFieldAltName($fieldindex); public function setFieldAltName($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 30 , $fieldindex); securepdf_pdfform_set($res, 30, $value , $fieldindex); ``` ## Default Value '' ## Remarks The alternate field name. This optional property contains a friendly name of the field, used when referring to the field in the user interface. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldCaption Property ([SecurePDF_PDFForm](#pdfform-class) Class) The caption of the button property. ## Object Oriented Interface ```text public function getFieldCaption($fieldindex); public function setFieldCaption($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 31 , $fieldindex); securepdf_pdfform_set($res, 31, $value , $fieldindex); ``` ## Default Value '' ## Remarks The caption of the button field. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldDefaultValue Property ([SecurePDF_PDFForm](#pdfform-class) Class) The default value of the form property. ## Object Oriented Interface ```text public function getFieldDefaultValue($fieldindex); public function setFieldDefaultValue($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 32 , $fieldindex); securepdf_pdfform_set($res, 32, $value , $fieldindex); ``` ## Default Value '' ## Remarks The default value of the form field. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldName Property ([SecurePDF_PDFForm](#pdfform-class) Class) The local name of the property. ## Object Oriented Interface ```text public function getFieldName($fieldindex); public function setFieldName($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 33 , $fieldindex); securepdf_pdfform_set($res, 33, $value , $fieldindex); ``` ## Default Value '' ## Remarks The local name of the field. This is normally a simple text string such as *mybutton*. See also [FieldFullName](#fieldfullname-property-securepdf_pdfform-class). The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldType Property ([SecurePDF_PDFForm](#pdfform-class) Class) The type of the property. ## Object Oriented Interface ```text public function getFieldType($fieldindex); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 34 , $fieldindex); ``` ## Possible Values ```text PDFFORM_FIELDTYPE_UNDEFINED(0), PDFFORM_FIELDTYPE_BUTTON(1), PDFFORM_FIELDTYPE_CHECKBOX(2), PDFFORM_FIELDTYPE_RADIO_GROUP(3), PDFFORM_FIELDTYPE_RADIO_BUTTON(4), PDFFORM_FIELDTYPE_TEXT_BOX(5), PDFFORM_FIELDTYPE_LIST_BOX(6), PDFFORM_FIELDTYPE_COMBO_BOX(7), PDFFORM_FIELDTYPE_SIGNATURE(8) ``` ## Default Value 0 ## Remarks The type of the field. Possible values are: | | | | --- | --- | | 0 (fftUndefined - default) | Undefined or unknown field type. | | 1 (fftButton) | A pushbutton. | | 2 (fftCheckbox) | A checkbox. | | 3 (fftRadioGroup) | A radio button group. | | 4 (fftRadioButton) | A radio button. | | 5 (fftTextBox) | A text box. | | 6 (fftListBox) | A list box. | | 7 (fftComboBox) | A drop-down combo box. | | 8 (fftSignature) | A signature field. | The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is read-only and not available at design time. ## Data Type Integer # FieldFullName Property ([SecurePDF_PDFForm](#pdfform-class) Class) The full name of the property. ## Object Oriented Interface ```text public function getFieldFullName($fieldindex); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 35 , $fieldindex); ``` ## Default Value '' ## Remarks The full name of the field. This is a concatenation of the local names of the subhierarchy of non-terminal fields leading from the root field to the current field, ending with the local name of the current field. For example, *buttons.ctlbuttons.mybutton*. See also [FieldName](#fieldname-property-securepdf_pdfform-class). The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is read-only and not available at design time. ## Data Type String # FieldHeight Property ([SecurePDF_PDFForm](#pdfform-class) Class) The displayed height of the property in points. ## Object Oriented Interface ```text public function getFieldHeight($fieldindex); public function setFieldHeight($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 36 , $fieldindex); securepdf_pdfform_set($res, 36, $value , $fieldindex); ``` ## Default Value '0' ## Remarks The displayed height of the field in points. Both integer and decimal values are supported. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldMaxLen Property ([SecurePDF_PDFForm](#pdfform-class) Class) The maximum length of data that the text box can accept. ## Object Oriented Interface ```text public function getFieldMaxLen($fieldindex); public function setFieldMaxLen($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 37 , $fieldindex); securepdf_pdfform_set($res, 37, $value , $fieldindex); ``` ## Default Value 0 ## Remarks The maximum length of data that the text box can accept. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type Integer # FieldOffsetX Property ([SecurePDF_PDFForm](#pdfform-class) Class) The displayed offset of the property from the left-hand page border in points. ## Object Oriented Interface ```text public function getFieldOffsetX($fieldindex); public function setFieldOffsetX($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 38 , $fieldindex); securepdf_pdfform_set($res, 38, $value , $fieldindex); ``` ## Default Value '0' ## Remarks The displayed offset of the field from the left-hand page border in points. Both integer and decimal values are supported. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldOffsetY Property ([SecurePDF_PDFForm](#pdfform-class) Class) The displayed offset of the property from the bottom page border in points. ## Object Oriented Interface ```text public function getFieldOffsetY($fieldindex); public function setFieldOffsetY($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 39 , $fieldindex); securepdf_pdfform_set($res, 39, $value , $fieldindex); ``` ## Default Value '0' ## Remarks The displayed offset of the field from the bottom page border in points. Both integer and decimal values are supported. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldOptions Property ([SecurePDF_PDFForm](#pdfform-class) Class) The set of options offered by a combo box or list box property. ## Object Oriented Interface ```text public function getFieldOptions($fieldindex); public function setFieldOptions($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 40 , $fieldindex); securepdf_pdfform_set($res, 40, $value , $fieldindex); ``` ## Default Value '' ## Remarks The set of options offered by a combo box or list box field. The options are returned as a multi-line string, with each string representing an individual choice. The data reported or accepted by this property depends on the value of [OptionsFormat](#OptionsFormat). The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldPageIndex Property ([SecurePDF_PDFForm](#pdfform-class) Class) The page index containing the property. ## Object Oriented Interface ```text public function getFieldPageIndex($fieldindex); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 41 , $fieldindex); ``` ## Default Value -1 ## Remarks The page index containing the field. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is read-only and not available at design time. ## Data Type Integer # FieldTerminal Property ([SecurePDF_PDFForm](#pdfform-class) Class) Whether the property is terminal, meaning it is represented by a leaf entry in the property tree. ## Object Oriented Interface ```text public function getFieldTerminal($fieldindex); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 42 , $fieldindex); ``` ## Default Value true ## Remarks Whether the field is terminal, meaning it is represented by a leaf entry in the field tree. Only terminal fields can carry data and be filled in or submitted. Any non-terminal (intermediate) fields are only used to define shared properties of a selection of descendant fields, terminal or non-terminal in their own right. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is read-only and not available at design time. ## Data Type Boolean # FieldValue Property ([SecurePDF_PDFForm](#pdfform-class) Class) The export value associated with the property. ## Object Oriented Interface ```text public function getFieldValue($fieldindex); public function setFieldValue($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 43 , $fieldindex); securepdf_pdfform_set($res, 43, $value , $fieldindex); ``` ## Default Value '' ## Remarks The export value associated with the field. This contains the data that is the value of the field from the processor's standpoint. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FieldVisible Property ([SecurePDF_PDFForm](#pdfform-class) Class) Whether the property is visible or hidden. ## Object Oriented Interface ```text public function getFieldVisible($fieldindex); public function setFieldVisible($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 44 , $fieldindex); securepdf_pdfform_set($res, 44, $value , $fieldindex); ``` ## Default Value false ## Remarks Whether the field is visible or hidden. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type Boolean # FieldWidth Property ([SecurePDF_PDFForm](#pdfform-class) Class) The displayed width of the property in points. ## Object Oriented Interface ```text public function getFieldWidth($fieldindex); public function setFieldWidth($fieldindex, $value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 45 , $fieldindex); securepdf_pdfform_set($res, 45, $value , $fieldindex); ``` ## Default Value '0' ## Remarks The displayed width of the field in points. Both integer and decimal values are supported. The *$fieldindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FieldCount](#fieldcount-property-securepdf_pdfform-class) property. This property is not available at design time. ## Data Type String # FontColor Property ([SecurePDF_PDFForm](#pdfform-class) Class) The color of the current font in hash-prefixed hexadecimal format or as a name. ## Object Oriented Interface ```text public function getFontColor(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 46 ); ``` ## Default Value '#000000' ## Remarks The color of the current font in hash-prefixed hexadecimal format or as a name. This property is read-only and not available at design time. ## Data Type String # FontName Property ([SecurePDF_PDFForm](#pdfform-class) Class) The name of the current font. ## Object Oriented Interface ```text public function getFontName(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 47 ); ``` ## Default Value 'Times New Roman' ## Remarks The name of the current font. This property is read-only and not available at design time. ## Data Type String # FontSize Property ([SecurePDF_PDFForm](#pdfform-class) Class) The size of the current font in points. ## Object Oriented Interface ```text public function getFontSize(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 48 ); ``` ## Default Value '12' ## Remarks The size of the current font in points. This property is read-only and not available at design time. ## Data Type String # FontStyle Property ([SecurePDF_PDFForm](#pdfform-class) Class) The style of the current font. ## Object Oriented Interface ```text public function getFontStyle(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 49 ); ``` ## Default Value '' ## Remarks The style of the current font. This property is read-only and not available at design time. ## Data Type String # InputData Property ([SecurePDF_PDFForm](#pdfform-class) Class) A byte array containing the PDF document to process. ## Object Oriented Interface ```text public function getInputData(); public function setInputData($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 50 ); securepdf_pdfform_set($res, 50, $value ); ``` ## Remarks This property is used to assign a byte array containing the PDF document to be processed. This property is not available at design time. ## Data Type Byte Array # InputFile Property ([SecurePDF_PDFForm](#pdfform-class) Class) The PDF file to process. ## Object Oriented Interface ```text public function getInputFile(); public function setInputFile($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 51 ); securepdf_pdfform_set($res, 51, $value ); ``` ## Default Value '' ## Remarks This property is used to provide a path to the PDF document to be processed. ## Data Type String # OutputData Property ([SecurePDF_PDFForm](#pdfform-class) Class) A byte array containing the PDF document after processing. ## Object Oriented Interface ```text public function getOutputData(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 52 ); ``` ## Remarks This property is used to read the byte array containing the produced output after the operation has completed. It is only set if an output file and output stream have not been assigned via [OutputFile](#outputfile-property-securepdf_pdfform-class) and SetOutputStream respectively. This property is read-only and not available at design time. ## Data Type Byte Array # OutputFile Property ([SecurePDF_PDFForm](#pdfform-class) Class) The path to a local file where the output is written. ## Object Oriented Interface ```text public function getOutputFile(); public function setOutputFile($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 53 ); securepdf_pdfform_set($res, 53, $value ); ``` ## Default Value '' ## Remarks This property is used to provide a path where the resulting PDF document is saved after the operation has completed. ## Data Type String # Overwrite Property ([SecurePDF_PDFForm](#pdfform-class) Class) Whether the class should overwrite files. ## Object Oriented Interface ```text public function getOverwrite(); public function setOverwrite($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 54 ); securepdf_pdfform_set($res, 54, $value ); ``` ## Default Value false ## Remarks This property indicates whether the class overwrites [OutputFile](#outputfile-property-securepdf_pdfform-class). If set to *false*, an error is thrown whenever [OutputFile](#outputfile-property-securepdf_pdfform-class) exists before an operation. ## Data Type Boolean # Password Property ([SecurePDF_PDFForm](#pdfform-class) Class) The password to decrypt the document with. ## Object Oriented Interface ```text public function getPassword(); public function setPassword($value); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 55 ); securepdf_pdfform_set($res, 55, $value ); ``` ## Default Value '' ## Remarks This property is used to provide the user password for decryption. Though it may be different from [OwnerPassword](#OwnerPassword), most implementations use the same value for both. ## Data Type String # PositionPageIndex Property ([SecurePDF_PDFForm](#pdfform-class) Class) The index of the current page in the PDF document. ## Object Oriented Interface ```text public function getPositionPageIndex(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 56 ); ``` ## Default Value 0 ## Remarks The index of the current page in the PDF document. This property is read-only and not available at design time. ## Data Type Integer # PositionX Property ([SecurePDF_PDFForm](#pdfform-class) Class) The X coordinate of the current position on the page. ## Object Oriented Interface ```text public function getPositionX(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 57 ); ``` ## Default Value '0' ## Remarks The X coordinate of the current position on the page. This property is read-only and not available at design time. ## Data Type String # PositionY Property ([SecurePDF_PDFForm](#pdfform-class) Class) The Y coordinate of the current position on the page. ## Object Oriented Interface ```text public function getPositionY(); ``` ## Procedural Interface ```text securepdf_pdfform_get($res, 58 ); ``` ## Default Value '0' ## Remarks The Y coordinate of the current position on the page. This property is read-only and not available at design time. ## Data Type String # AddBitmap Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a bitmap image to the document. ## Object Oriented Interface ```text public function doAddBitmap($format, $bitmapbytes, $bitmapwidth, $bitmapheight, $scalex, $scaley); ``` ## Procedural Interface ```text securepdf_pdfform_do_addbitmap($res, $format, $bitmapbytes, $bitmapwidth, $bitmapheight, $scalex, $scaley); ``` ## Remarks This method is used to add a bitmap image to the document at the current Position. *Format* and *BitmapBytes* specify the format and raw data of the serialized image respectively. Possible values for the former are: - JPEG2000 - JPEG - Custom *BitmapWidth* and *BitmapHeight* specify the original width and height of the bitmap in pixels. *ScaleX* and *ScaleY* 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 ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a button field to the form. ## Object Oriented Interface ```text public function doAddButton($name, $caption); ``` ## Procedural Interface ```text securepdf_pdfform_do_addbutton($res, $name, $caption); ``` ## Remarks This method is used to create a button field with name *Name* and caption *Caption* at the current Position. The button is added to the end of the Fields collection 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 collection. # AddCaption Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a caption for a form field. ## Object Oriented Interface ```text public function doAddCaption($caption); ``` ## Procedural Interface ```text securepdf_pdfform_do_addcaption($res, $caption); ``` ## Remarks This method is used to add a *Caption* (title) for a form field at the current Position. # AddCheckBox Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a checkbox field to the form. ## Object Oriented Interface ```text public function doAddCheckBox($name, $defaultvalue); ``` ## Procedural Interface ```text securepdf_pdfform_do_addcheckbox($res, $name, $defaultvalue); ``` ## Remarks This method is used to create a checkbox field with name *Name* at the current Position. *DefaultValue* specifies the initial state of the checkbox (checked/unchecked). The checkbox field is added to the end of the Fields collection 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 collection. # AddComboBox Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a combo box field to the form. ## Object Oriented Interface ```text public function doAddComboBox($name, $options, $defaultvalue); ``` ## Procedural Interface ```text securepdf_pdfform_do_addcombobox($res, $name, $options, $defaultvalue); ``` ## Remarks This method is used to create a combo box field with name *Name* at the current Position. *Options* specifies a list of choices as a multi-line string. *DefaultValue* specifies the initial value selected in the combo box. The new combo box field is added to the end of the Fields collection 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 collection. # AddDrawing Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a vector drawing to the document. ## Object Oriented Interface ```text public function doAddDrawing($format, $drawingbytes, $scalex, $scaley); ``` ## Procedural Interface ```text securepdf_pdfform_do_adddrawing($res, $format, $drawingbytes, $scalex, $scaley); ``` ## Remarks This method is used to add a vector drawing to the document at the current Position. *Format* and *DrawingBytes* specify the format and raw data (as an encoded PDF appearance stream) of the drawing respectively. The former is reserved for future use. *ScaleX* and *ScaleY* 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 ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a list box field to the form. ## Object Oriented Interface ```text public function doAddListBox($name, $options, $defaultvalue); ``` ## Procedural Interface ```text securepdf_pdfform_do_addlistbox($res, $name, $options, $defaultvalue); ``` ## Remarks This method is used to create a list box field with name *Name* at the current Position. *Options* specifies a list of choices as a multi-line string. *DefaultValue* specifies the initial value selected in the list box. The new list box field is added to the end of the Fields collection 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 collection. # AddNewPage Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a new blank page to the document. ## Object Oriented Interface ```text public function doAddNewPage($pageindex); ``` ## Procedural Interface ```text securepdf_pdfform_do_addnewpage($res, $pageindex); ``` ## Remarks This method is used to add a new page to the document at the position specified by *PageIndex* (zero-based). Use [DefaultPageWidth](#DefaultPageWidth) and [DefaultPageHeight](#DefaultPageHeight) to adjust the new page dimensions. Note that upon completion of this method, the Position will not be automatically moved to the newly added page. # AddRadioButton Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a radio button to the form. ## Object Oriented Interface ```text public function doAddRadioButton($radiogroup, $name, $isdefaultbutton); ``` ## Procedural Interface ```text securepdf_pdfform_do_addradiobutton($res, $radiogroup, $name, $isdefaultbutton); ``` ## Remarks This method is used to create a radio button field with name *Name*, within the radio group *RadioGroup*, at the current Position. *IsDefaultButton* specifies whether the radio button will be selected initially (i.e., whether it will be the of the radio group). The new radio button field is added to the end of the Fields collection 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 collection. # AddTextBox Method ([SecurePDF_PDFForm](#pdfform-class) Class) Adds a text box field to the form. ## Object Oriented Interface ```text public function doAddTextBox($name, $defaultvalue, $password); ``` ## Procedural Interface ```text securepdf_pdfform_do_addtextbox($res, $name, $defaultvalue, $password); ``` ## Remarks This method is used to create a text box field with name *Name* at the current Position. *DefaultValue* specifies the initial value contained in the text box. *Password* specifies whether the text box is intended to contain a password. Pass *true* to have the text displayed as asterisk characters (***). The new text box field is added to the end of the Fields collection 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 collection. # Close Method ([SecurePDF_PDFForm](#pdfform-class) Class) Closes the opened document. ## Object Oriented Interface ```text public function doClose(); ``` ## Procedural Interface ```text securepdf_pdfform_do_close($res); ``` ## Remarks This method is used to close the previously opened document. It should always be preceded by a call to [Open](#open-method-securepdf_pdfform-class). **Example:** ```csharp component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); ``` If any changes are made to the document, they are saved automatically to [OutputFile](#outputfile-property-securepdf_pdfform-class), [OutputData](#outputdata-property-securepdf_pdfform-class), or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges). # Config Method ([SecurePDF_PDFForm](#pdfform-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text securepdf_pdfform_do_config($res, $configurationstring); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pdfform-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-pdfform-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # CreateNew Method ([SecurePDF_PDFForm](#pdfform-class) Class) Creates a new PDF document. ## Object Oriented Interface ```text public function doCreateNew(); ``` ## Procedural Interface ```text securepdf_pdfform_do_createnew($res); ``` ## Remarks This method is used to create a blank PDF document with one empty page. Use [DefaultPageWidth](#DefaultPageWidth) and [DefaultPageHeight](#DefaultPageHeight) to adjust the new page dimensions. Having created the baseline document, use the class's methods to add objects to it. # Encrypted Method ([SecurePDF_PDFForm](#pdfform-class) Class) Checks whether the document is encrypted. ## Object Oriented Interface ```text public function doEncrypted(); ``` ## Procedural Interface ```text securepdf_pdfform_do_encrypted($res); ``` ## Remarks This method is used to determine whether the document is encrypted. It returns *false* if the document is pseudo-encrypted with an empty password. **Example:** ```csharp 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 opens it, performs the operation, then closes it. # FindField Method ([SecurePDF_PDFForm](#pdfform-class) Class) Locates a field in the document. ## Object Oriented Interface ```text public function doFindField($name); ``` ## Procedural Interface ```text securepdf_pdfform_do_findfield($res, $name); ``` ## Remarks This method is used to quickly locate the field with name *Name* in the document. This method returns the index of the field in the Fields collection, or *-1* if the field was not found. # Flatten Method ([SecurePDF_PDFForm](#pdfform-class) Class) Flattens the form by removing the interactive form fields. ## Object Oriented Interface ```text public function doFlatten(); ``` ## Procedural Interface ```text securepdf_pdfform_do_flatten($res); ``` ## 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 ([SecurePDF_PDFForm](#pdfform-class) Class) Returns the value of a field property. ## Object Oriented Interface ```text public function doGetFieldProperty($fieldindex, $fieldproperty); ``` ## Procedural Interface ```text securepdf_pdfform_do_getfieldproperty($res, $fieldindex, $fieldproperty); ``` ## Remarks This method is used to obtain the value of a field property. Together with [SetFieldProperty](#setfieldproperty-method-securepdf_pdfform-class), 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. *FieldIndex* is the index of the field of interest in the Fields collection, and *FieldProperty* specifies the field property to read. Possible values are: | 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 appears 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 [](#f_Options) can be selected simultaneously in the combo box or list box field. | | NoExport | False | Whether the field is not 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 [](#f_Value). | | Required | False | Whether the field must have a [](#f_Value) before the form can be submitted. | | Sort | False | Whether the [](#f_Options) are 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 [](#f_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](#documentinfo-event-securepdf_pdfform-class) event. # GetPageProperty Method ([SecurePDF_PDFForm](#pdfform-class) Class) Returns the value of a page property. ## Object Oriented Interface ```text public function doGetPageProperty($pageindex, $pageproperty); ``` ## Procedural Interface ```text securepdf_pdfform_do_getpageproperty($res, $pageindex, $pageproperty); ``` ## Remarks This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details. *PageIndex* specifies the page to read information about (with a valid range from *0* to *PageCount - 1*), and *PageProperty* specifies the page property to read. Possible values are: | 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. | | 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 clockwise. Supported values: 0, 90, 180, 270. | | Width | 0 | The width of the page in points. | **Example:** ```csharp 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: ```csharp 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](#documentinfo-event-securepdf_pdfform-class) event. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # Open Method ([SecurePDF_PDFForm](#pdfform-class) Class) Opens the document for processing. ## Object Oriented Interface ```text public function doOpen(); ``` ## Procedural Interface ```text securepdf_pdfform_do_open($res); ``` ## Remarks This method is used to open the document specified in [InputFile](#inputfile-property-securepdf_pdfform-class), [InputData](#inputdata-property-securepdf_pdfform-class), or SetInputStream before performing some operation on it, such as adding, editing, or removing form fields. When finished, call [Close](#close-method-securepdf_pdfform-class) to complete or discard the operation. It is recommended to use this method (alongside [Close](#close-method-securepdf_pdfform-class)) when performing multiple operations on the document at once. NOTE: This method populates the Fields properties with any form fields found in the document. # RemoveField Method ([SecurePDF_PDFForm](#pdfform-class) Class) Removes a field from the document. ## Object Oriented Interface ```text public function doRemoveField($index); ``` ## Procedural Interface ```text securepdf_pdfform_do_removefield($res, $index); ``` ## Remarks This method is used to remove a field from the document. *Index* specifies the index of the field in the Fields collection to be removed. NOTE: This method can only be used with terminal fields. # RemoveFieldByName Method ([SecurePDF_PDFForm](#pdfform-class) Class) Removes a field from the document. ## Object Oriented Interface ```text public function doRemoveFieldByName($name); ``` ## Procedural Interface ```text securepdf_pdfform_do_removefieldbyname($res, $name); ``` ## Remarks This method is used to remove a field from the document. *Name* specifies the full name of the field in the Fields collection to be removed. NOTE: This method can only be used with terminal fields. # Reset Method ([SecurePDF_PDFForm](#pdfform-class) Class) Resets the class. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text securepdf_pdfform_do_reset($res); ``` ## Remarks This method is used to reset the class's properties and configuration settings to their default values. # SetFieldProperty Method ([SecurePDF_PDFForm](#pdfform-class) Class) Sets the value of a field property. ## Object Oriented Interface ```text public function doSetFieldProperty($fieldindex, $fieldproperty, $value); ``` ## Procedural Interface ```text securepdf_pdfform_do_setfieldproperty($res, $fieldindex, $fieldproperty, $value); ``` ## Remarks This method is used to modify the value of a field property. Together with [GetFieldProperty](#getfieldproperty-method-securepdf_pdfform-class), 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. *FieldIndex* is the index of the field of interest in the Fields collection, and *FieldProperty* and *Value* specify the field property and value to set respectively. Possible values for the former are: | 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 appears 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 [](#f_Options) can be selected simultaneously in the combo box or list box field. | | NoExport | False | Whether the field is not 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 [](#f_Value). | | Required | False | Whether the field must have a [](#f_Value) before the form can be submitted. | | Sort | False | Whether the [](#f_Options) are 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 [](#f_FieldName) and value for the on state. | # SetFont Method ([SecurePDF_PDFForm](#pdfform-class) Class) Sets the font properties to be applied to text. ## Object Oriented Interface ```text public function doSetFont($name, $size, $style, $color); ``` ## Procedural Interface ```text securepdf_pdfform_do_setfont($res, $name, $size, $style, $color); ``` ## Remarks This method is used to define the font attributes for text. *Name* specifies the font name. *Size* specifies the font size, either as an absolute value (e.g., *12*) or relative adjustment (e.g., *+2*). *Style* specifies the font style. The following syntax is supported: *[B][I][bold][italic][##%][##%,##%][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. *Color* 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 | # SetPosition Method ([SecurePDF_PDFForm](#pdfform-class) Class) Sets the page and position for new form fields, text blocks, or images. ## Object Oriented Interface ```text public function doSetPosition($pageindex, $x, $y); ``` ## Procedural Interface ```text securepdf_pdfform_do_setposition($res, $pageindex, $x, $y); ``` ## Remarks This method is used to define the Position where new form fields, text blocks, or images are added. The page is identified by *PageIndex* (zero-based), *X* specifies the horizontal position, and *Y* specifies the vertical position. *X* and *Y* values that are absolute, relative to the current position, and relative to the page dimensions are all supported. **Example:** ```csharp // Sets to exact coordinates. pdfform.SetPosition(0, "100", "20"); // Moves 20 points to the right and 20 points down from the current position. pdfform.SetPosition(0, "{x}+20", "{y}-20"); // Moves 20 points from the right edge and 120 points from the top edge of the page. pdfform.SetPosition(0, "{width}-20", "{height}-120"); ``` NOTE: *PageIndex* set to *-1* specifies the last page of the document. # DocumentInfo Event ([SecurePDF_PDFForm](#pdfform-class) Class) Fired when the document has been loaded into memory. ## Object Oriented Interface ```text public function fireDocumentInfo($param); ``` ## Procedural Interface ```text securepdf_pdfform_register_callback($res, 1, array($this, 'fireDocumentInfo')); ``` ## Parameter List ```text 'pagecount' 'signaturecount' ``` ## 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, [GetPageProperty](#getpageproperty-method-securepdf_pdfform-class) can be used to find the optimal position for the signature widget. *PageCount* reports the number of pages in the document. *SignatureCount* reports the number of signatures in the document. This event is fired when [Open](#open-method-securepdf_pdfform-class) is called, but only after [Password](#password-event-securepdf_pdfform-class) or [RecipientInfo](#recipientinfo-event-securepdf_pdfform-class) is fired (if applicable) and the document has been decrypted. # Error Event ([SecurePDF_PDFForm](#pdfform-class) Class) Fired when information is available about errors during data delivery. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text securepdf_pdfform_register_callback($res, 2, array($this, 'fireError')); ``` ## Parameter List ```text 'errorcode' 'description' ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-pdfform-class) section. # Log Event ([SecurePDF_PDFForm](#pdfform-class) Class) Fired once for each log message. ## Object Oriented Interface ```text public function fireLog($param); ``` ## Procedural Interface ```text securepdf_pdfform_register_callback($res, 3, array($this, 'fireLog')); ``` ## Parameter List ```text 'loglevel' 'message' 'logtype' ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) configuration setting. *LogLevel* 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. | *Message* is the log message. *LogType* identifies the type of log entry. Possible values are: - CertValidator - Font - HTTP - PDFInvalidSignature - PDFRevocationInfo - Timestamp - TSL # Password Event ([SecurePDF_PDFForm](#pdfform-class) Class) Fired when the class detects that the document is encrypted with a password. ## Object Oriented Interface ```text public function firePassword($param); ``` ## Procedural Interface ```text securepdf_pdfform_register_callback($res, 4, array($this, 'firePassword')); ``` ## Parameter List ```text 'available' 'cancel' ``` ## 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 [Password](#password-property-securepdf_pdfform-class). *Available* indicates whether the decryption password is already available to the class or still needs to be set. If this parameter is *false*, the correct password must be provided for the decryption attempt to succeed. *Cancel* determines whether the class will stop firing this event to request a password. # RecipientInfo Event ([SecurePDF_PDFForm](#pdfform-class) Class) Fired for each recipient certificate of the encrypted document. ## Object Oriented Interface ```text public function fireRecipientInfo($param); ``` ## Procedural Interface ```text securepdf_pdfform_register_callback($res, 5, array($this, 'fireRecipientInfo')); ``` ## Parameter List ```text 'issuer' 'serialnumber' 'subjectkeyidentifier' 'available' 'cancel' ``` ## 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 DecryptionCert. *Issuer* specifies the subject of the issuer certificate. *SerialNumber* specifies the serial number of the encryption certificate. *SubjectKeyIdentifier* specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string. *Available* indicates whether the decryption certificate is already available to the class or still needs to be set. If this parameter is *false*, the correct certificate must be provided for the decryption attempt to succeed. *Cancel* determines whether the class will stop firing this event to request a certificate. NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate causes its own invocation of this event. # Config Settings ([PDFForm](#pdfform-class) Class) The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-securepdf_pdfform-class) method. ### PDFForm Config Settings **AutoTurnPages**: Whether to change the page automatically upon exceeding the upper or lower page boundary.This setting specifies whether the class turns the page automatically. If set to *true*, the class automatically progresses to the next or previous page upon reaching a page boundary while adding new elements or changing the page position. If set to *false*, any new elements are added to the current page, even if they are outside of the visible page region. The default value is *true*. **CloseInputStreamAfterProcessing**: Whether to close the input stream after processing.This setting determines whether the input stream specified in SetInputStream will be closed after processing is complete. The default value is *true*. **CloseOutputStreamAfterProcessing**: Whether to close the output stream after processing.This setting determines whether the output stream specified in SetOutputStream will be closed after processing is complete. The default value is *true*. **CompressStreams**: Whether to compress stream objects.This setting specifies whether the bytes in the document's stream objects are compressed when the document is saved. The default value is *true*. **DefaultPageHeight**: The default height for newly added pages.This setting specifies the default height, in points, of pages added using [CreateNew](#createnew-method-securepdf_pdfform-class) or [AddNewPage](#addnewpage-method-securepdf_pdfform-class). The default value is *0*, meaning the class reuses the height of the previous page when adding a new page. If the new page is the first in the document, the height defaults to the standard *792*. **DefaultPageWidth**: The default width for newly added pages.This setting specifies the default width, in points, of pages added using [CreateNew](#createnew-method-securepdf_pdfform-class) or [AddNewPage](#addnewpage-method-securepdf_pdfform-class). The default value is *0*, meaning the class reuses the width of the previous page when adding a new page. If the new page is the first in the document, the width defaults to the standard *612*. **EnforcePDFA**: Whether to enforce PDF/A compliance.This setting specifies whether the class enforces PDF/A compliance when operating on the document. If set to *true*, [PDFALevel](#PDFALevel) and [PDFAPolicy](#PDFAPolicy) are used to establish the level of PDF/A compliance to apply. The default value is *true*. **FallbackFont**: The fallback font.This setting specifies the font that the class uses if it cannot find the intended font on the local system. In PDF/A, fonts must be embedded into the document, so this setting can be useful when text must be added but no font is available. **FontPaths**: The font search paths.This setting specifies a CRLF-separated list of directories where the class searches for additional TrueType font files. It is used when resolving a TrueType font specified in [SetFont](#setfont-method-securepdf_pdfform-class) without a full file path. Each entry is interpreted as a directory path used during font lookup. To use a specific TrueType font file, either specify its filename and include the containing directory in this setting, or specify the full file path in [SetFont](#setfont-method-securepdf_pdfform-class). The default value is the system font search paths. These paths are platform-dependent: | | | | --- | --- | | Windows | %windir%\Fonts and %LOCALAPPDATA%\Microsoft\Windows\Fonts | | macOS and iOS | /System/Library/Fonts/, /Library/Fonts/, and ~/Library/Fonts/ | | Linux | Directories listed by dir entries in /etc/fonts/fonts.conf and /usr/local/etc/fonts/fonts.conf | | Android | /system/fonts | On Windows, the .NET and Java editions obtain these locations through the runtime APIs or the *windir*, *SystemRoot*, and *LOCALAPPDATA* environment variables. To use custom directories together with the default system locations, include both to prevent the current search path list from being replaced. For example: ```csharp string fontPaths = component.Config("FontPaths"); fontPaths += @"\r\nC:\Fonts"; component.Config("FontPaths=" + fontPaths); ``` **KeepPositionOnInsert**: Whether to keep the current position after inserting an element.This setting specifies whether the class keeps the current position at the set value after inserting an element. In the default configuration, insertion of a new element, such as a text block, moves the page position marker to the right of the newly inserted element. If set to *true*, the class keeps the position marker at its original location after adding the element. The default value is *false*. **ListboxFlatten**: The flattening mode for list box fields.This setting specifies how the class flattens list box fields. Possible values are: | | | | --- | --- | | 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. | **LoadMedia**: Whether to load images from the document.This setting specifies whether the class loads images from the document. If media does not need to be accessed, keep it set to *false* to speed up document processing. The default value is *false*. **LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-securepdf_pdfform-class) event. 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. | **OptionsFormat**: The format of the options in a combo box or list box field.This setting specifies how the class formats the in a combo box or list box field. Possible values are: | | | | --- | --- | | 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,==). | **OwnerPassword**: The owner password to decrypt the document with.This setting is used to provide the document owner password for decryption. Though it may be different from [Password](#password-property-securepdf_pdfform-class), most implementations use the same value for both. **PDFALevel**: The PDF/A conformance level to enforce.This setting specifies the desired PDF/A conformance level that the class attempts to enforce when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | 1 | PDF/A-1 | | 2 | PDF/A-2 | | 3 (default) | PDF/A-3 | **PDFAPolicy**: The PDF/A policy to follow.This setting specifies the PDF/A policy the class follows when [EnforcePDFA](#EnforcePDFA) is set to *true*. Possible values are: | | | | --- | --- | | Default | Maps to Preserve. | | Preserve | Keep existing document features and only write PDF/A-compliant pieces. If the class needs to write a non-compliant piece, it throws an exception. | | Enforce | Preserve PDF/A-compliant pieces and attempt to fix violations in the original document. | **RightPadding**: The width of the whitespace gap to the right of newly added elements.This setting specifies the width, in points, of the empty space that is allowed to the right of newly added elements. Using a non-zero value for this setting allows multiple text blocks and other elements to be placed next to each other without sticking them together. This setting is ignored if [KeepPositionOnInsert](#KeepPositionOnInsert) is set to *true*. The default value is *5*. **SaveChanges**: Whether to save changes made to the document.This setting specifies whether and how changes made to the PDF document are saved when [Close](#close-method-securepdf_pdfform-class) is called. Possible values are: | | | | --- | --- | | 0 | Discard all changes. | | 1 | Save the document to [OutputFile](#outputfile-property-securepdf_pdfform-class), [OutputData](#outputdata-property-securepdf_pdfform-class), or the stream set in SetOutputStream, even if it has not been modified. | | 2 (default) | Save the document to [OutputFile](#outputfile-property-securepdf_pdfform-class), [OutputData](#outputdata-property-securepdf_pdfform-class), or the stream set in SetOutputStream, but only if it has been modified. | **SystemFontNames**: The system font names.This setting returns a CRLF-separated list of system TrueType font names that are supported by the class. This setting is read-only. **TempPath**: The location where temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. It can be useful to reduce memory usage. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). 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 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | 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 | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - 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. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([PDFForm](#pdfform-class) Class) ### 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](#outputfile-property-securepdf_pdfform-class) already exists and [Overwrite](#overwrite-property-securepdf_pdfform-class) 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 ([](#f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [](#f_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. |