OutputOptions Class

Additional document level options

These options are available for all signature operations of the Signer. They can also be used without a signature operation with the method Process(Document, Stream, OutputOptions, Provider).

Notes on document encryption when processing files with the Signer:

PDF/A conformance is removed from input files. In this case, a Warning with an PdfARemoved is generated.
Signed documents cannot be encrypted or decrypted. In this case, a Warning with an SignedDocEncryptionUnchanged is generated.

Inheritance Hierarchy

SystemObject
  PdfTools.InternalNativeBase
    PdfTools.InternalNativeObject
      PdfTools.PdfOutputOptions
        PdfTools.SignOutputOptions

Namespace: PdfTools.Sign
Assembly: PdfTools (in PdfTools.dll) Version: 1.1.0.0

Syntax

Copy

public class OutputOptions : OutputOptions

The OutputOptions type exposes the following members.

Constructors

	Name	Description
	OutputOptions

Top

Properties

	Name	Description
	AddValidationInformation	Add validation information to existing signatures of input document Add signature validation information to the document security store (DSS). This information includes: All certificates of the signing certificate’s trust chain, unless they are already embedded into the signature. Revocation data (OCSP or CRL) for all certificates that support revocation information. This method can be used to create signatures with long-term validation material or to enlarge the longevity of existing signatures. For more details on validation information, see also ValidationInformation. Validation information for embedded time-stamp tokens is added as well. If adding validation information fails, an Warning with an AddValidationInformationFailed is generated. All types of cryptographic providers support this method. However, this method fails when using a provider whose certificate store is missing a required certificate. Note: This property has no effect on any new signatures or time-stamp that may also be added. The validation information of signatures and time-stamps is controlled by the respective property in the signature or time-stamp configuration object. Note: This method does not validate the signatures, but only downloads the information required. Note: Adding validation information for expired certificates is not possible. Therefore, it is crucial to enlarge the longevity of signatures before they expire. Note: Adding validation information to document certification (MDP) signatures is not possible, because it would break the signature. Validation information must be added to certification signatures when creating them. Default: None
	Encryption	The parameters to encrypt output PDFs If , no encryption is used. Encryption is not allowed by the PDF/A ISO standards. For that reason, it is recommended to use when processing PDF/A documents. Otherwise, most operations will remove PDF/A conformance from the output document. More details can be found in the documentation of the operation. Default: , no encryption is used. (Inherited from OutputOptions)
	RemoveSignatures	Whether to remove any signatures By default, all signatures of the input document are preserved. Optionally, some or all of them can be removed. Default: None

Name

Description

AddValidationInformation

Add validation information to existing signatures of input document

Add signature validation information to the document security store (DSS). This information includes:

All certificates of the signing certificate’s trust chain, unless they are already embedded into the signature.
Revocation data (OCSP or CRL) for all certificates that support revocation information.

This method can be used to create signatures with long-term validation material or to enlarge the longevity of existing signatures. For more details on validation information, see also ValidationInformation.

Validation information for embedded time-stamp tokens is added as well.

If adding validation information fails, an Warning with an AddValidationInformationFailed is generated.

All types of cryptographic providers support this method. However, this method fails when using a provider whose certificate store is missing a required certificate.

Note: This property has no effect on any new signatures or time-stamp that may also be added. The validation information of signatures and time-stamps is controlled by the respective property in the signature or time-stamp configuration object.

Note: This method does not validate the signatures, but only downloads the information required.

Note: Adding validation information for expired certificates is not possible. Therefore, it is crucial to enlarge the longevity of signatures before they expire.

Note: Adding validation information to document certification (MDP) signatures is not possible, because it would break the signature. Validation information must be added to certification signatures when creating them.

Default: None

Encryption

The parameters to encrypt output PDFs

If , no encryption is used.

Encryption is not allowed by the PDF/A ISO standards. For that reason, it is recommended to use when processing PDF/A documents. Otherwise, most operations will remove PDF/A conformance from the output document. More details can be found in the documentation of the operation.

Default: , no encryption is used.

(Inherited from OutputOptions)

RemoveSignatures

Whether to remove any signatures

By default, all signatures of the input document are preserved. Optionally, some or all of them can be removed.

Default: None

Top

Methods

	Name	Description
	Equals	(Inherited from NativeObject)
	GetHashCode	(Inherited from NativeObject)

Top

Reference

PdfTools.Sign Namespace