GemBox.Pdf.Forms Namespace

Contains classes, structures, and enumerations that implement PDF interactive forms (PDF 1.2) (sometimes referred to as AcroForms) used for gathering information interactively from the user as specified in the PDF Specification ISO 32000-1:2008, section '12.7 Interactive Forms', and digital signatures (PDF 1.3) used to authenticate the identity of a user and the document’s contents as specified in the section '12.8 Digital Signatures'. The base class of all PDF fields is PdfField which can be accessed via the Fields property of the PdfInteractiveForm class.

The PDF interactive form is represented by the PdfInteractiveForm class which can be accessed via the Form property of the PdfDocument class.

A digital signature is represented by the PdfSignature class and is stored in the Value property of the PdfSignatureField class. PDF files can be digitally signed by using PdfSignatureField's Sign(PdfSigner) methods as demonstrated in the digital signature examples.

Classes

PdfButtonAppearance	Represents an appearance settings for a PdfButtonField.
PdfButtonField	Represents a pushbutton which is a purely interactive control that responds immediately to user input without retaining a permanent value (see 12.7.4.2.2, "Pushbuttons").
PdfCheckBoxField	Represents a check box that toggles between two states, on and off (see 12.7.4.2.3, "Check Boxes").
PdfChoiceField	Represents a base class for choice fields, such as PdfListBoxField and PdfDropdownField, that contain several text items, at most one of which may be selected as the field value.
PdfChoiceFieldItemCollection	Represents a collection of PdfChoiceFieldItems.
PdfDropdownField	Represents a combo box consisting of a drop-down list. The combo box may be accompanied by an editable text box in which the user can type a value other than the predefined choices.
PdfField	Represents a base class for all fields in an interactive form.
PdfFieldActionCollection	Represents a collection of PdfField's actions performed when the mouse button is released inside the field's annotation active area. This collection also exposes actions for other trigger events (beside mouse button release) via MouseEnter, MouseExit, MouseDown, OnFocus and OnBlur properties.
PdfFieldAppearance	Represents an appearance settings for a PdfField.
PdfFieldCollection	Represents a collection of all fields in an interactive form.
PdfFormActionSelectedFieldCollection	Represents a collection of PdfField names used in PdfSubmitFormAction and PdfResetFormAction.
PdfImportFormDataAction	An import-data action imports Forms Data Format (FDF) data into the document's interactive form from a specified file.
PdfInteractiveForm	An interactive form (PDF 1.2)—sometimes referred to as an AcroForm—is a collection of fields for gathering information interactively from the user. A PDF document may contain any number of fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document.
PdfListBoxField	Represents a scrollable list box.
PdfRadioButtonField	Represents a radio button field in a set of related buttons that can each be on or off. Typically, at most one radio button in a set may be on at any given time, and selecting any one of the buttons automatically deselects all the others. (There are exceptions to this rule, as noted in "Radio Buttons").
PdfResetFormAction	A reset-form action resets selected interactive form fields to their default values.
PdfSignature	A digital signature (PDF 1.3) may be used to authenticate the identity of a user and the document’s contents. It stores information about the signer and the state of the document when it was signed.
PdfSignatureAppearance	Represents an appearance settings for a PdfSignatureField.
PdfSignatureContent	Represents the content of the PdfSignature. For public-key signatures, PdfSignatureContent should be either a DER-encoded PKCS#1 binary data object or a DER-encoded CMS binary data object. For document timestamp signatures, PdfSignatureContent shall be the TimeStampToken as specified in RFC 3161 as updated by RFC 5816. The value of the messageImprint field within the TimeStampToken shall be a hash of the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the Content value).
PdfSignatureField	Represents a signature field (PDF 1.3) which is a form field that contains a digital signature (see 12.8, "Digital Signatures").
PdfSignatureLock	Specifies what changes, made to the document after the signature was applied, invalidate the signature. The AuthorPermission is specified by a certification signature (also known as an author signature) (PDF 1.5) which shall be the value of the first signed field in the document. It enables the author to specify what changes made to the document invalidate the author's signature. The LockedFields is specified by either a certification signature or a regular, approval signature (also known as a recipient signature). It enables the signer to specify a set of form fields whose change invalidate the signature. Other set of changes, such as those that invalidate a usage rights signature or an FDF file signature (the Identity transform method), are currently not exposed because they are deprecated.
PdfSignatureLockedFieldCollection	Represents a set of form fields whose change invalidate the signature.
PdfSignaturePolicyIdentifier	A signature policy defines the rules for creation and validation of an electronic signature, and is included as a signed attribute with every PAdES Enhanced Explicit Policy Electronic Signature (PAdES-E-EPES and legacy PAdES-E-EPES).
PdfSignatureValidationInfo	Represents a container that shall contain validation-related information (VRI) for one signature in the document that a given signature handler or PDF processor has used to successfully validate the given signature. A PdfSignatureValidationInfo shall reference: a selection of certificates from the Certificates in the PdfDocumentSecurityStore applicable to the signature; a selection of certificate revocation lists (CRLs) from the CertificateRevocationLists in the PdfDocumentSecurityStore applicable to the signature, if any; a selection of Online Certificate Status Protocol (OCSP) responses from the OnlineCertificateStatusProtocolResponses in the PdfDocumentSecurityStore applicable to the signature.
PdfSignatureValidationResult	Represents a result of a PdfSignature validation.
PdfSigner	Represents a signer that computes the Content in a format specified by SignatureFormat.
PdfSubmitFormAction	A submit-form action transmits the names and values of selected interactive form fields to a specified uniform resource locator (URL).
PdfTextField	Represents a box or space for text fill-in data typically entered from a keyboard.
PdfToggleButtonAppearance	Represents an appearance settings for a toggle button fields PdfCheckBoxField and PdfRadioButtonField.
PdfToggleButtonField	Represents a base class for button fields that can switch states, such as PdfCheckBoxField and PdfRadioButtonField.
PdfVariableTextAppearance	Represents an appearance settings for a variable text fields PdfTextField, PdfDropdownField and PdfListBoxField.
PdfVariableTextField	Represents a base class for variable text fields, such as PdfTextField, PdfDropdownField and PdfListBoxField.

Structs

PdfChoiceFieldItem	Represents an item for a PdfChoiceField.
PdfFieldCollection.Enumerator	Enumerates the elements of a PdfFieldCollection.

Enums

PdfFieldType	Represents types of the PdfFields.
PdfFormDataFormat	Represents a file format used for exporting interactive form data via ExportData(String) methods and for submitting interactive form data via PdfSubmitFormAction.
PdfSignatureFormat	Represents an encoding of the signature value and key information in the signature dictionary.
PdfSignatureLevel	Represents levels of PDF Advanced Electronic Signature (PAdES) baseline signatures, intended to facilitate interoperability and to encompass the life cycle of PAdES signature. The levels PAdES_B_LT and PAdES_B_LTA are appropriate where the technical validity of signature needs to be preserved for a period of time after signature creation where certificate expiration, revocation and/or algorithm obsolescence is of concern. PAdES_B_LTA level targets long term availability and integrity of the validation material of digital signatures over long term. The B-LTA level can help to validate the signature beyond many events that limit its validity (for instance, the weakness of used cryptographic algorithms, or expiration of validation data). The use of B-LTA level is considered an appropriate preservation and transmission technique for signed data.