# PDFForm Class The PDFForm class offers PDF form management capabilities. ## Syntax ```text pdfsdk.PDFForm ``` ## 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-pdfform-class)), byte array ([InputData](#inputdata-property-pdfform-class)), or stream ([SetInputStream](#setinputstream-method-pdfform-class)) and call [Open](#open-method-pdfform-class). This method populates the [Fields](#fields-property-pdfform-class) collection with the existing form fields in the document. When finished editing the form, call [Close](#close-method-pdfform-class) to close the document and save the changes to either [OutputFile](#outputfile-property-pdfform-class), [OutputData](#outputdata-property-pdfform-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfform-class). ### 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](#fields-property-pdfform-class) collection, making it easy to access the [PDFField](#pdffield-type) 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-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-pdfform-class) is not explicitly called, the field is placed on the first page of the document by default. [SetFont](#setfont-method-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-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-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-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-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-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-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-pdfform-class) and [RemoveFieldByName](#removefieldbyname-method-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](#pdffield-type) object from the [Fields](#fields-property-pdfform-class) collection. [RemoveField](#removefield-method-pdfform-class) removes a form field identified by its index, whereas [RemoveFieldByName](#removefieldbyname-method-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.* | | | | --- | --- | | [DecryptionCert](#decryptioncert-property-pdfform-class) | The decryption certificate. | | [Fields](#fields-property-pdfform-class) | The entire collection of form fields contained in the document. | | [Font](#font-property-pdfform-class) | The currently set font. | | [InputData](#inputdata-property-pdfform-class) | A byte array containing the PDF document to process. | | [InputFile](#inputfile-property-pdfform-class) | The PDF file to process. | | [OutputData](#outputdata-property-pdfform-class) | A byte array containing the PDF document after processing. | | [OutputFile](#outputfile-property-pdfform-class) | The path to a local file where the output is written. | | [Overwrite](#overwrite-property-pdfform-class) | Whether the class should overwrite files. | | [Password](#password-property-pdfform-class) | The password to decrypt the document with. | | [Position](#position-property-pdfform-class) | The currently set position. | ## 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-pdfform-class) | Adds a bitmap image to the document. | | [AddButton](#addbutton-method-pdfform-class) | Adds a button field to the form. | | [AddCaption](#addcaption-method-pdfform-class) | Adds a caption for a form field. | | [AddCheckBox](#addcheckbox-method-pdfform-class) | Adds a checkbox field to the form. | | [AddComboBox](#addcombobox-method-pdfform-class) | Adds a combo box field to the form. | | [AddDrawing](#adddrawing-method-pdfform-class) | Adds a vector drawing to the document. | | [AddListBox](#addlistbox-method-pdfform-class) | Adds a list box field to the form. | | [AddNewPage](#addnewpage-method-pdfform-class) | Adds a new blank page to the document. | | [AddRadioButton](#addradiobutton-method-pdfform-class) | Adds a radio button to the form. | | [AddTextBox](#addtextbox-method-pdfform-class) | Adds a text box field to the form. | | [Close](#close-method-pdfform-class) | Closes the opened document. | | [Config](#config-method-pdfform-class) | Sets or retrieves a configuration setting. | | [CreateNew](#createnew-method-pdfform-class) | Creates a new PDF document. | | [Encrypted](#encrypted-method-pdfform-class) | Checks whether the document is encrypted. | | [FindField](#findfield-method-pdfform-class) | Locates a field in the document. | | [Flatten](#flatten-method-pdfform-class) | Flattens the form by removing the interactive form fields. | | [GetFieldProperty](#getfieldproperty-method-pdfform-class) | Returns the value of a field property. | | [GetPageProperty](#getpageproperty-method-pdfform-class) | Returns the value of a page property. | | [Open](#open-method-pdfform-class) | Opens the document for processing. | | [RemoveField](#removefield-method-pdfform-class) | Removes a field from the document. | | [RemoveFieldByName](#removefieldbyname-method-pdfform-class) | Removes a field from the document. | | [Reset](#reset-method-pdfform-class) | Resets the class. | | [SetFieldProperty](#setfieldproperty-method-pdfform-class) | Sets the value of a field property. | | [SetFont](#setfont-method-pdfform-class) | Sets the font properties to be applied to text. | | [SetInputStream](#setinputstream-method-pdfform-class) | Sets the stream containing the PDF document to process. | | [SetOutputStream](#setoutputstream-method-pdfform-class) | Sets the stream to write the processed document to. | | [SetPosition](#setposition-method-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-pdfform-class) | Fired when the document has been loaded into memory. | | [Error](#error-event-pdfform-class) | Fired when information is available about errors during data delivery. | | [Log](#log-event-pdfform-class) | Fired once for each log message. | | [Password](#password-event-pdfform-class) | Fired when the class detects that the document is encrypted with a password. | | [RecipientInfo](#recipientinfo-event-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. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | | [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. | # DecryptionCert Property ([PDFForm](#pdfform-class) Class) The decryption certificate. ## Syntax ```text public Certificate getDecryptionCert(); public void setDecryptionCert(Certificate decryptionCert); ``` ## Remarks This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # Fields Property ([PDFForm](#pdfform-class) Class) The entire collection of form fields contained in the document. ## Syntax ```text public PDFFieldList getFields(); ``` ## Remarks This property is used to access individual form fields within the document. The PDF specification allows for an advanced, tree-like structure of the form fields, with each field residing within that tree. Much like in the object-oriented approach, form fields inherit properties from the fields that are their immediate parents in the tree. The leaf fields, called "terminal" by the specification, are the actual fields available for filling in and submitting. The fields occupying intermediate tree nodes are abstract and are only there to define a set of their descendant fields. The PDFForm class flattens the tree structure, presenting the fields as one linear list. The following mechanisms can be used to navigate the tree: - Use [Terminal](#PDFField_f_Terminal) to find out if the field is terminal/leaf and can be filled in. - [FullName](#PDFField_f_FullName) contains the full name of the field in dotted format (*parent.intermediate.child*). Remove the last element from the name to obtain the name of the parent field (*parent.intermediate* in this case). - Use [FindField](#findfield-method-pdfform-class) to easily locate the field in the Fields collection. Use [AddButton](#addbutton-method-pdfform-class), [AddCheckBox](#addcheckbox-method-pdfform-class), [AddRadioButton](#addradiobutton-method-pdfform-class), and similar methods to add new fields to the form. Then edit the properties of the [PDFField](#pdffield-type) objects published in the Fields collection to modify them. This property is read-only and not available at design time. Please refer to the [PDFField](#pdffield-type) type for a complete list of fields. # Font Property ([PDFForm](#pdfform-class) Class) The currently set font. ## Syntax ```text public PDFFont getFont(); ``` ## Remarks This property is used to access the font details specified using [SetFont](#setfont-method-pdfform-class). This property is read-only and not available at design time. Please refer to the [PDFFont](#pdffont-type) type for a complete list of fields. # InputData Property ([PDFForm](#pdfform-class) Class) A byte array containing the PDF document to process. ## Syntax ```text public byte[] getInputData(); public void setInputData(byte[] inputData); ``` ## Remarks This property is used to assign a byte array containing the PDF document to be processed. This property is not available at design time. # InputFile Property ([PDFForm](#pdfform-class) Class) The PDF file to process. ## Syntax ```text public String getInputFile(); public void setInputFile(String inputFile); ``` ## Default Value "" ## Remarks This property is used to provide a path to the PDF document to be processed. # OutputData Property ([PDFForm](#pdfform-class) Class) A byte array containing the PDF document after processing. ## Syntax ```text public byte[] getOutputData(); ``` ## 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-pdfform-class) and [SetOutputStream](#setoutputstream-method-pdfform-class) respectively. This property is read-only and not available at design time. # OutputFile Property ([PDFForm](#pdfform-class) Class) The path to a local file where the output is written. ## Syntax ```text public String getOutputFile(); public void setOutputFile(String outputFile); ``` ## Default Value "" ## Remarks This property is used to provide a path where the resulting PDF document is saved after the operation has completed. # Overwrite Property ([PDFForm](#pdfform-class) Class) Whether the class should overwrite files. ## Syntax ```text public boolean isOverwrite(); public void setOverwrite(boolean overwrite); ``` ## Default Value False ## Remarks This property indicates whether the class overwrites [OutputFile](#outputfile-property-pdfform-class). If set to *false*, an error is thrown whenever [OutputFile](#outputfile-property-pdfform-class) exists before an operation. # Password Property ([PDFForm](#pdfform-class) Class) The password to decrypt the document with. ## Syntax ```text public String getPassword(); public void setPassword(String password); ``` ## 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. # Position Property ([PDFForm](#pdfform-class) Class) The currently set position. ## Syntax ```text public PDFPagePosition getPosition(); ``` ## Remarks This property is used to access the position details specified using [SetPosition](#setposition-method-pdfform-class). This property is read-only and not available at design time. Please refer to the [PDFPagePosition](#pdfpageposition-type) type for a complete list of fields. # AddBitmap Method ([PDFForm](#pdfform-class) Class) Adds a bitmap image to the document. ## Syntax ```text public void addBitmap(String format, byte[] bitmapBytes, int bitmapWidth, int bitmapHeight, String scaleX, String scaleY); ``` ## Remarks This method is used to add a bitmap image to the document at the current [Position](#position-property-pdfform-class). *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 ([PDFForm](#pdfform-class) Class) Adds a button field to the form. ## Syntax ```text public int addButton(String name, String caption); ``` ## Remarks This method is used to create a button field with name *Name* and caption *Caption* at the current [Position](#position-property-pdfform-class). The button is added to the end of the [Fields](#fields-property-pdfform-class) collection and can be modified using the properties of the respective [PDFField](#pdffield-type) object. This method returns the index of the newly added field in the [Fields](#fields-property-pdfform-class) collection. # AddCaption Method ([PDFForm](#pdfform-class) Class) Adds a caption for a form field. ## Syntax ```text public void addCaption(String caption); ``` ## Remarks This method is used to add a *Caption* (title) for a form field at the current [Position](#position-property-pdfform-class). # AddCheckBox Method ([PDFForm](#pdfform-class) Class) Adds a checkbox field to the form. ## Syntax ```text public int addCheckBox(String name, boolean defaultValue); ``` ## Remarks This method is used to create a checkbox field with name *Name* at the current [Position](#position-property-pdfform-class). *DefaultValue* specifies the initial state of the checkbox (checked/unchecked). The checkbox field is added to the end of the [Fields](#fields-property-pdfform-class) collection and can be modified using the properties of the respective [PDFField](#pdffield-type) object. This method returns the index of the newly added field in the [Fields](#fields-property-pdfform-class) collection. # AddComboBox Method ([PDFForm](#pdfform-class) Class) Adds a combo box field to the form. ## Syntax ```text public int addComboBox(String name, String options, String defaultValue); ``` ## Remarks This method is used to create a combo box field with name *Name* at the current [Position](#position-property-pdfform-class). *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](#fields-property-pdfform-class) collection and can be modified using the properties of the respective [PDFField](#pdffield-type) object. This method returns the index of the newly added field in the [Fields](#fields-property-pdfform-class) collection. # AddDrawing Method ([PDFForm](#pdfform-class) Class) Adds a vector drawing to the document. ## Syntax ```text public void addDrawing(String format, byte[] drawingBytes, String scaleX, String scaleY); ``` ## Remarks This method is used to add a vector drawing to the document at the current [Position](#position-property-pdfform-class). *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 ([PDFForm](#pdfform-class) Class) Adds a list box field to the form. ## Syntax ```text public int addListBox(String name, String options, String defaultValue); ``` ## Remarks This method is used to create a list box field with name *Name* at the current [Position](#position-property-pdfform-class). *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](#fields-property-pdfform-class) collection and can be modified using the properties of the respective [PDFField](#pdffield-type) object. This method returns the index of the newly added field in the [Fields](#fields-property-pdfform-class) collection. # AddNewPage Method ([PDFForm](#pdfform-class) Class) Adds a new blank page to the document. ## Syntax ```text public void addNewPage(int 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](#position-property-pdfform-class) will not be automatically moved to the newly added page. # AddRadioButton Method ([PDFForm](#pdfform-class) Class) Adds a radio button to the form. ## Syntax ```text public int addRadioButton(String radioGroup, String name, boolean isDefaultButton); ``` ## Remarks This method is used to create a radio button field with name *Name*, within the radio group *RadioGroup*, at the current [Position](#position-property-pdfform-class). *IsDefaultButton* specifies whether the radio button will be selected initially (i.e., whether it will be the [DefaultValue](#PDFField_f_DefaultValue) of the radio group). The new radio button field is added to the end of the [Fields](#fields-property-pdfform-class) collection and can be modified using the properties of the respective [PDFField](#pdffield-type) object. This method returns the index of the newly added field in the [Fields](#fields-property-pdfform-class) collection. # AddTextBox Method ([PDFForm](#pdfform-class) Class) Adds a text box field to the form. ## Syntax ```text public int addTextBox(String name, String defaultValue, boolean password); ``` ## Remarks This method is used to create a text box field with name *Name* at the current [Position](#position-property-pdfform-class). *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](#fields-property-pdfform-class) collection and can be modified using the properties of the respective [PDFField](#pdffield-type) object. This method returns the index of the newly added field in the [Fields](#fields-property-pdfform-class) collection. # Close Method ([PDFForm](#pdfform-class) Class) Closes the opened document. ## Syntax ```text public void close(); ``` ## Remarks This method is used to close the previously opened document. It should always be preceded by a call to [Open](#open-method-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-pdfform-class), [OutputData](#outputdata-property-pdfform-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfform-class) when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges). # Config Method ([PDFForm](#pdfform-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String 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 ([PDFForm](#pdfform-class) Class) Creates a new PDF document. ## Syntax ```text public void createNew(); ``` ## 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 ([PDFForm](#pdfform-class) Class) Checks whether the document is encrypted. ## Syntax ```text public boolean encrypted(); ``` ## 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 ([PDFForm](#pdfform-class) Class) Locates a field in the document. ## Syntax ```text public int findField(String name); ``` ## Remarks This method is used to quickly locate the field with name *Name* in the document. This method returns the index of the field in the [Fields](#fields-property-pdfform-class) collection, or *-1* if the field was not found. # Flatten Method ([PDFForm](#pdfform-class) Class) Flattens the form by removing the interactive form fields. ## Syntax ```text public void flatten(); ``` ## Remarks This method is used to substitute all the existing form fields in the document with their currently set values, thus fixing them. This method strips the interactive form features from the document. The flattened fields are no longer fields and can no longer be modified or extracted. Any signatures that may have been included in the original document are removed from the flattened document. # GetFieldProperty Method ([PDFForm](#pdfform-class) Class) Returns the value of a field property. ## Syntax ```text public String getFieldProperty(int fieldIndex, String fieldProperty); ``` ## Remarks This method is used to obtain the value of a field property. Together with [SetFieldProperty](#setfieldproperty-method-pdfform-class), this method provides an extensible way of managing the field settings that are not available through the [PDFField](#pdffield-type) type. The list of settings below may be extended in the future. *FieldIndex* is the index of the field of interest in the [Fields](#fields-property-pdfform-class) 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 [Options](#PDFField_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 [Value](#PDFField_f_Value). | | Required | False | Whether the field must have a [Value](#PDFField_f_Value) before the form can be submitted. | | Sort | False | Whether the [Options](#PDFField_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 [FieldName](#PDFField_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-pdfform-class) event. # GetPageProperty Method ([PDFForm](#pdfform-class) Class) Returns the value of a page property. ## Syntax ```text public String getPageProperty(int pageIndex, String pageProperty); ``` ## Remarks This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details. *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-pdfform-class) event. NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it. # Open Method ([PDFForm](#pdfform-class) Class) Opens the document for processing. ## Syntax ```text public void open(); ``` ## Remarks This method is used to open the document specified in [InputFile](#inputfile-property-pdfform-class), [InputData](#inputdata-property-pdfform-class), or [SetInputStream](#setinputstream-method-pdfform-class) before performing some operation on it, such as adding, editing, or removing form fields. When finished, call [Close](#close-method-pdfform-class) to complete or discard the operation. It is recommended to use this method (alongside [Close](#close-method-pdfform-class)) when performing multiple operations on the document at once. NOTE: This method populates the [Fields](#fields-property-pdfform-class) collection with any form fields found in the document. # RemoveField Method ([PDFForm](#pdfform-class) Class) Removes a field from the document. ## Syntax ```text public void removeField(int index); ``` ## Remarks This method is used to remove a field from the document. *Index* specifies the index of the field in the [Fields](#fields-property-pdfform-class) collection to be removed. NOTE: This method can only be used with terminal fields. # RemoveFieldByName Method ([PDFForm](#pdfform-class) Class) Removes a field from the document. ## Syntax ```text public void removeFieldByName(String name); ``` ## Remarks This method is used to remove a field from the document. *Name* specifies the full name of the field in the [Fields](#fields-property-pdfform-class) collection to be removed. NOTE: This method can only be used with terminal fields. # Reset Method ([PDFForm](#pdfform-class) Class) Resets the class. ## Syntax ```text public void reset(); ``` ## Remarks This method is used to reset the class's properties and configuration settings to their default values. # SetFieldProperty Method ([PDFForm](#pdfform-class) Class) Sets the value of a field property. ## Syntax ```text public void setFieldProperty(int fieldIndex, String fieldProperty, String value); ``` ## Remarks This method is used to modify the value of a field property. Together with [GetFieldProperty](#getfieldproperty-method-pdfform-class), this method provides an extensible way of managing the field settings that are not available through the [PDFField](#pdffield-type) type. The list of settings below may be extended in the future. *FieldIndex* is the index of the field of interest in the [Fields](#fields-property-pdfform-class) 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 [Options](#PDFField_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 [Value](#PDFField_f_Value). | | Required | False | Whether the field must have a [Value](#PDFField_f_Value) before the form can be submitted. | | Sort | False | Whether the [Options](#PDFField_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 [FieldName](#PDFField_f_FieldName) and value for the on state. | # SetFont Method ([PDFForm](#pdfform-class) Class) Sets the font properties to be applied to text. ## Syntax ```text public void setFont(String name, String size, String style, String 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 | # SetInputStream Method ([PDFForm](#pdfform-class) Class) Sets the stream containing the PDF document to process. ## Syntax ```text public void setInputStream(java.io.InputStream inputStream); ``` ## Remarks This method is used to set the stream from which the class reads the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class reads the data from the input stream instead of from the [InputFile](#inputfile-property-pdfform-class) or [InputData](#inputdata-property-pdfform-class) properties. NOTE: It may be useful to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) to *true* when using input streams. # SetOutputStream Method ([PDFForm](#pdfform-class) Class) Sets the stream to write the processed document to. ## Syntax ```text public void setOutputStream(java.io.OutputStream outputStream); ``` ## Remarks This method is used to set the stream to which the class writes the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class writes the data to the output stream instead of writing to [OutputFile](#outputfile-property-pdfform-class) or populating [OutputData](#outputdata-property-pdfform-class). NOTE: It may be useful to additionally set [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) to *true* when using output streams. # SetPosition Method ([PDFForm](#pdfform-class) Class) Sets the page and position for new form fields, text blocks, or images. ## Syntax ```text public void setPosition(int pageIndex, String X, String Y); ``` ## Remarks This method is used to define the [Position](#position-property-pdfform-class) 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 ([PDFForm](#pdfform-class) Class) Fired when the document has been loaded into memory. ## Syntax ```text public class DefaultPDFFormEventListener implements PDFFormEventListener { ... public void documentInfo(PDFFormDocumentInfoEvent e) {} ... } public class PDFFormDocumentInfoEvent { public int pageCount; public int 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-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-pdfform-class) is called, but only after [Password](#password-event-pdfform-class) or [RecipientInfo](#recipientinfo-event-pdfform-class) is fired (if applicable) and the document has been decrypted. # Error Event ([PDFForm](#pdfform-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text public class DefaultPDFFormEventListener implements PDFFormEventListener { ... public void error(PDFFormErrorEvent e) {} ... } public class PDFFormErrorEvent { public int errorCode; public String description; } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-pdfform-class) section. # Log Event ([PDFForm](#pdfform-class) Class) Fired once for each log message. ## Syntax ```text public class DefaultPDFFormEventListener implements PDFFormEventListener { ... public void log(PDFFormLogEvent e) {} ... } public class PDFFormLogEvent { public int logLevel; public String message; public String 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 ([PDFForm](#pdfform-class) Class) Fired when the class detects that the document is encrypted with a password. ## Syntax ```text public class DefaultPDFFormEventListener implements PDFFormEventListener { ... public void password(PDFFormPasswordEvent e) {} ... } public class PDFFormPasswordEvent { public boolean available; public boolean cancel; //read-write } ``` ## 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-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 ([PDFForm](#pdfform-class) Class) Fired for each recipient certificate of the encrypted document. ## Syntax ```text public class DefaultPDFFormEventListener implements PDFFormEventListener { ... public void recipientInfo(PDFFormRecipientInfoEvent e) {} ... } public class PDFFormRecipientInfoEvent { public String issuer; public String serialNumber; public String subjectKeyIdentifier; public boolean available; public boolean cancel; //read-write } ``` ## 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](#decryptioncert-property-pdfform-class). *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. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *String* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys. NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey). **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *byte[]* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* 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 field 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](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#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 [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) 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. | **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *int (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte[]* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # PDFField Type A single form field. ## Remarks This type provides access to the properties of an individual field object. The following fields are available: - [Action](#PDFField_f_Action) - [AltName](#PDFField_f_AltName) - [Caption](#PDFField_f_Caption) - [DefaultValue](#PDFField_f_DefaultValue) - [FieldName](#PDFField_f_FieldName) - [FieldType](#PDFField_f_FieldType) - [FullName](#PDFField_f_FullName) - [Height](#PDFField_f_Height) - [MaxLen](#PDFField_f_MaxLen) - [OffsetX](#PDFField_f_OffsetX) - [OffsetY](#PDFField_f_OffsetY) - [Options](#PDFField_f_Options) - [PageIndex](#PDFField_f_PageIndex) - [Terminal](#PDFField_f_Terminal) - [Value](#PDFField_f_Value) - [Visible](#PDFField_f_Visible) - [Width](#PDFField_f_Width) ## Fields **Action** *String* *Default Value: ""* The JavaScript action assigned to the button field. This action is executed if the button is pressed. **AltName** *String* *Default Value: ""* The alternate field name. This optional property contains a friendly name of the field, used when referring to the field in the user interface. **Caption** *String* *Default Value: ""* The caption of the button field. **DefaultValue** *String* *Default Value: ""* The default value of the form field. **FieldName** *String* *Default Value: ""* The local name of the field. This is normally a simple text string such as *mybutton*. See also [FullName](#PDFField_f_FullName). **FieldType** *int (read-only)* *Default Value: 0* 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. | **FullName** *String (read-only)* *Default Value: ""* The full name of the field. This is a concatenation of the local names of the subhierarchy of non-terminal fields leading from the root field to the current field, ending with the local name of the current field. For example, *buttons.ctlbuttons.mybutton*. See also [FieldName](#PDFField_f_FieldName). **Height** *String* *Default Value: "0"* The displayed height of the field in points. Both integer and decimal values are supported. **MaxLen** *int* *Default Value: 0* The maximum length of data that the text box can accept. **OffsetX** *String* *Default Value: "0"* The displayed offset of the field from the left-hand page border in points. Both integer and decimal values are supported. **OffsetY** *String* *Default Value: "0"* The displayed offset of the field from the bottom page border in points. Both integer and decimal values are supported. **Options** *String* *Default Value: ""* The set of options offered by a combo box or list box field. The options are returned as a multi-line string, with each string representing an individual choice. The data reported or accepted by this property depends on the value of [OptionsFormat](#OptionsFormat). **PageIndex** *int (read-only)* *Default Value: -1* The page index containing the field. **Terminal** *boolean (read-only)* *Default Value: True* Whether the field is terminal, meaning it is represented by a leaf entry in the field tree. Only terminal fields can carry data and be filled in or submitted. Any non-terminal (intermediate) fields are only used to define shared properties of a selection of descendant fields, terminal or non-terminal in their own right. **Value** *String* *Default Value: ""* The export value associated with the field. This contains the data that is the value of the field from the processor's standpoint. **Visible** *boolean* *Default Value: False* Whether the field is visible or hidden. **Width** *String* *Default Value: "0"* The displayed width of the field in points. Both integer and decimal values are supported. ## Constructors ```text public PDFField(); ``` # PDFFont Type The font used in the PDF document. ## Remarks This type contains details about the font being applied to text. The following fields are available: - [Color](#PDFFont_f_Color) - [Name](#PDFFont_f_Name) - [Size](#PDFFont_f_Size) - [Style](#PDFFont_f_Style) ## Fields **Color** *String (read-only)* *Default Value: "#000000"* The color of the current font in hash-prefixed hexadecimal format or as a name. **Name** *String (read-only)* *Default Value: "Times New Roman"* The name of the current font. **Size** *String (read-only)* *Default Value: "12"* The size of the current font in points. **Style** *String (read-only)* *Default Value: ""* The style of the current font. ## Constructors ```text public PDFFont(); ``` # PDFPagePosition Type The position within a PDF document. ## Remarks This type contains information about the current position on a page. The following fields are available: - [PageIndex](#PDFPagePosition_f_PageIndex) - [X](#PDFPagePosition_f_X) - [Y](#PDFPagePosition_f_Y) ## Fields **PageIndex** *int (read-only)* *Default Value: 0* The index of the current page in the PDF document. **X** *String (read-only)* *Default Value: "0"* The X coordinate of the current position on the page. **Y** *String (read-only)* *Default Value: "0"* The Y coordinate of the current position on the page. ## Constructors ```text public PDFPagePosition(); ``` # 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-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](#setinputstream-method-pdfform-class) 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](#setoutputstream-method-pdfform-class) 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-pdfform-class) or [AddNewPage](#addnewpage-method-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-pdfform-class) or [AddNewPage](#addnewpage-method-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-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-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-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 [Options](#PDFField_f_Options) 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-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-pdfform-class) is called. Possible values are: | | | | --- | --- | | 0 | Discard all changes. | | 1 | Save the document to [OutputFile](#outputfile-property-pdfform-class), [OutputData](#outputdata-property-pdfform-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfform-class), even if it has not been modified. | | 2 (default) | Save the document to [OutputFile](#outputfile-property-pdfform-class), [OutputData](#outputdata-property-pdfform-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfform-class), 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. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events. **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*. **UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. **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. This setting is set to *false* by default on all platforms. **UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*. # 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-pdfform-class) already exists and [Overwrite](#overwrite-property-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](#decryptioncert-property-pdfform-class) error. The error description contains the detailed message. | | 841 | Encryption failed. The error description contains the detailed message. | | 842 | No proper certificate for encryption found. | | 846 | Unsupported revision. | | 847 | Unsupported security handler SubFilter. | | 848 | Failed to verify permissions. | | 849 | Invalid password. | | 850 | Invalid password information. | | 852 | Unsupported encryption algorithm. | | 859 | Cannot encrypt encrypted document. | | 864 | Cannot modify document after signature update. | | 868 | Cannot encrypt or decrypt object. | | 869 | Invalid security handler information. | | 870 | Invalid encrypted data. | | 871 | Invalid block cipher padding. | | 872 | Failed to reload signature. | | 873 | Object is not encrypted. | | 874 | Unexpected cipher information. | | 877 | Invalid document. Bad document catalog. | | 878 | Invalid document Id. | | 880 | Invalid document. Invalid requirements dictionary. | | 881 | Invalid linearization dictionary. | | 882 | Invalid signature information. | | 883 | Unsupported document format. | | 890 | Unsupported feature. | | 891 | Internal error. The error description contains the detailed message. | | 892 | Unsupported color. | | 893 | This operation is not supported for this PDF/A level. | | 894 | Interactive features ([Action](#PDFField_f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [Action](#PDFField_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. |