PdfDigitalSignature class

PdfDigitalSignature class

Contains Pdf Digital signature properties.

Inheritance: PdfDigitalSignature → DigitalSignature → BaseSignature

The PdfDigitalSignature type exposes the following members:

Constructors

Constructor Description
init Initialize Pdf Digital Signature with no certificate.
init Create Pdf Digital signature with specified certificate.

Properties

Property Description
signature_type Specifies the type of signature.
page_number Specifies the page signature was found on.
signature_id Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.
is_signature Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).
deleted Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.
created_on Get or set the signature creation date.
modified_on Get or set the signature modification date.
top Specifies top position of signature.
left Specifies left position of signature.
width Specifies width of signature.
height Specifies height of signature.
certificate Gets or sets the X509 certificate.
comments Gets or sets the signing purpose comment.
is_valid Keeps true if this digital signature is valid and the document has not been tampered with.
sign_time Gets or sets the time the document was signed.
certificate_custom_store_name Specifies the custom store name of the certificate.
x_ad_es_type XAdES type DigitalSignature.x_ad_es_type. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents.
thumbprint Gets the thumbprint of a certificate.
contact_info Information provided by the signer to enable a recipient to contact the signer
to verify the signature, e.g. a phone number.
location The CPU host name or physical location of the signing.
reason The reason for the signing, such as (I agree…).
type Type of Pdf digital signature.
time_stamp Time stamp for Pdf digital signature.
Default value is null.
show_properties Force to show/hide signature properties. In case ShowProperties is true signature
field has predefined format of appearance
Digitally signed by {PdfDigitalSignature.contact_info} Date: {Date} Reason: {PdfDigitalSignature.reason}
Location: {PdfDigitalSignature.location}
ShowProperties is true by default.

Methods

Method Description
load_digital_signatures Load Digital signatures from all system X509 Certificates Stores.
load_digital_signatures Load Digital signatures from a certificate storage.
clone Clone Barcode Signature instance.

See Also

PageInfo class PdfMetadataSignature class