 | SignerSign Method |
Add a document signature
Document signatures are sometimes also called approval signatures. This type of signature lets you verify the integrity of the signed part of the document and authenticate the signer’s identity.
The features and format of the signature are defined by the Provider and the configuration.
Non-critical processing errors raise a Warning. It is recommended to review the WarningCategory and handle them if necessary for the application.
Namespace: PdfTools.Sign
Assembly: PdfTools (in PdfTools.dll) Version: 1.0.0
SyntaxC#
public Document Sign( Document document, SignatureConfiguration configuration, Stream stream, OutputOptions outputOptions = null )
Parameters
- document Document
- The input document to sign
- configuration SignatureConfiguration
- The signature configuration
- stream Stream
- The stream where the signed document is written
- outputOptions OutputOptions (Optional)
- Document-level output options not directly related to the signature
Return Value
DocumentThe signed document
Exceptions| Exception | Condition |
|---|---|
| LicenseException | The license check has failed. |
| IOException | Writing to the stream failed. |
| UnsupportedFeatureException | The input PDF contains unrendered XFA form fields. See Xfa for more information on how to detect and handle XFA documents. |
| ArgumentException | If the configuration is invalid, e.g. because the creating provider has been closed. |
| ArgumentException | If the configuration is invalid, e.g. because it has been revoked. |
| NotFoundException | If the FieldName does not exist in document. |
| NotFoundException | If an image, a PDF or a font file for the visual appearance could not be found. |
| RetryException | If an unexpected error occurs that can be resolved by retrying the operation. For example, if a signature service returns an unexpectedly large signature. |
| RetryException | If a resource required by the cryptographic provider is temporarily unavailable. |
| HttpException | If a network error occurs, e.g. downloading revocation information (OCSP, CRL) or a time-stamp. |
| UnsupportedFeatureException | If the cryptographic provider does not support the requested signing algorithm. |
| PermissionException | If the cryptographic provider does not allow the signing operation. |
| ArgumentNullException | if document is . |
| ArgumentNullException | if configuration is . |
| ArgumentNullException | if stream is . |
See Also