PDF Properties
Encoder Property List
The following is the full list of the properties of the encoder task with short descriptions. Click on the links for further details.
| AlgorithmCaption | The displayed caption describing the algorithm in the signature widget. |
| AuthorName | The name of the author. |
| Background | Specifies the full path to an image file used for the signature widget background. |
| BackgroundStyle | This property specifies the style of signature widget background. |
| ContactInfo | Contact information for the signer. |
| EncryptData | Whether to encrypt the PDF. |
| EncryptionAlgorithm | The encryption algorithm. |
| EncryptionCert | The Certificate that will be used to encrypt the PDF. |
| EncryptionCertPKCS11Params | The PKCS11 Certificate(s) that will be used to encrypt the PDF. |
| EncryptionType | The type of encryption to perform. |
| InputFile | The full path to the input file. |
| Invisible | Specifies whether the signature widget is visible. |
| Location | The physical location or machine name where the document was signed. |
| Other | Defines a set of configuration settings to be used by the task. |
| OutputFile | The full path to the output file. |
| Overwrite | Whether or not the component should overwrite the output file. |
| Page | The page number on which the signature widget is displayed. |
| Password | Specifies the password used to encrypt the document. |
| Reason | Specifies a string stating the reason for the signature. |
| RuntimeLicense | Specifies the component runtime license key. |
| ShowOnAllPages | Whether to show the signature widget on all pages of the document. |
| SignatureHashAlgorithm | Specifies the signature hash algorithm. |
| SignatureType | Whether to sign or certify the PDF. |
| SignData | Whether to sign the PDF. |
| SignerCaption | Specifies the caption displayed before the signer information. |
| SignExistingFields | Whether to sign existing fields. |
| SigningCert | The certificate that will be used to sign or certify the PDF. |
| SigningCertPKCS11Params | The PKCS11 certificate that will be used to sign or certify the PDF. |
| TempPath | A temporary directory where data can be stored before the component processes it. |
| TimestampServer | The URL of the timestamp server. |
| TrustedCert | Specifies a Certificate that can be used to validate the trust of other certificates. |
| TrustedCertPKCS11Params | Specifies a PKCS11 Certificate that can be used to validate the trust of other certificates. |
Decoder Property List
The following is the full list of the properties of the decoder task with short descriptions. Click on the links for further details.
| DecryptionCert | The Certificate that will be used to decrypt the PDF. |
| DecryptionCertPKCS11Params | The PKCS11 Certificate that will be used to decrypt the PDF. |
| ExtractLastSignedVersion | Specifies whether to extract only the signed elements of the document, from the most recent signature. |
| InputFile | The full path to the input file. |
| KnownCert | Specifies an intermediary certificate in a trusted certificate chain. |
| KnownCertPKCS11Params | Specifies an intermediary PKCS11 certificate in a crusted certificate chain. |
| Other | Defines a set of configuration settings to be used by the task. |
| OutputFile | The full path to the output file. |
| Overwrite | Whether or not the component should overwrite the output file. |
| Password | Specifies the password used to encrypt the document. |
| RequireAllSignatures | Specifies whether to throw an error if not all SignerCerts were used to sign the PDF. |
| RequireCertification | Specifies whether an error should be thrown if the PDF document is not certified. |
| RequireEncryption | Specifies whether an error should be thrown if the PDF document is not encrypted. |
| RequireNonEmptyPass | Specifies whether an error should be thrown if the PDF was encrypted with an empty password. |
| RequirePublicKeyEncryption | Specifies whether an error should be thrown if the PDF document was not encrypted using a Public Key. |
| RequireSignature | Specifies whether to throw an error if the received PDF was not signed. |
| RequireTimestamp | Specifies whether a signature must have an associated timestamp to be successfully verified. |
| RuntimeLicense | Specifies the component runtime license key. |
| SignerCert | The Certificate that was used to sign or certify the PDF. |
| SignerCertPKCS11Params | The PKCS11 Certificate that was used to sign or certify the PDF. |
| TempPath | A temporary directory where data can be stored before the component processes it. |
| TrustAllCertificates | Specifies whether Certificate validation should automatically succeed. |
| TrustedCert | Specifies a Certificate that can be used to validate the trust of other certificates. |
| TrustedCertPKCS11Params | Specifies a PKCS11 Certificate that can be used to validate the trust of other certificates. |