PdfDigitalSignature class

PdfDigitalSignature class

Represents PDF digital signature properties.

The PdfDigitalSignature type exposes the following members:

Constructors

Constructor Description
init Initializes a PDF digital signature without a certificate.
init Initializes a PDF digital signature using the specified X509 store. The first certificate from the store will be used.
init Initializes a PDF digital signature using the specified X509 store and certificate index.
init Initializes a PDF digital signature with the specified X509 certificate.

Methods

Method Description
clone Clone PDF digital signature instance.
equals Compares signature properties to determine equality.
equals_object
get_hash_code Overrides the GetHashCode method.
load_digital_signatures Load digital signatures from all system X509 certificate stores. (inherited from DigitalSignature)
load_digital_signatures_file (inherited from DigitalSignature)
load_digital_signatures_store_name (inherited from DigitalSignature)
load_digital_signatures_string (inherited from DigitalSignature)

Properties

Property Description
contact_info The contact information provided by the signer to enable a recipient 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…).
show_properties The flag that forces the signature properties to be shown or hidden; when true, the signature field uses a predefined appearance format (e.g., Digitally signed by {PdfDigitalSignature.contact_info} Date: {Date} Reason: {PdfDigitalSignature.reason} Location: {PdfDigitalSignature.location}) and defaults to True.
time_stamp The time stamp for a PDF digital signature. Default value is None.
type The type of PDF digital signature.
certificate The X509 certificate associated with the digital signature. (inherited from DigitalSignature)
certificate_custom_store_name The custom store name of the certificate. (inherited from DigitalSignature)
certificate_store_location The store location of the certificate. (inherited from DigitalSignature)
certificate_store_name The store name of the certificate. (inherited from DigitalSignature)
comments The signing purpose comment. (inherited from DigitalSignature)
created_on The signature creation date. (inherited from BaseSignature)
deleted The flag indicating whether this signature was deleted from the document. (inherited from BaseSignature)
height The height of the signature. (inherited from BaseSignature)
is_signature The flag indicating whether this component represents a signature (True) or document content (False). (inherited from BaseSignature)
is_valid The digital signature is valid and the document has not been tampered with. (inherited from DigitalSignature)
left The left position of the signature. (inherited from BaseSignature)
modified_on The signature modification date. (inherited from BaseSignature)
page_number The page number where the signature was found. (inherited from BaseSignature)
sign_time The time the document was signed. (inherited from DigitalSignature)
signature_id The unique identifier of the signature, used to modify the signature in the document via update or delete operations. (inherited from BaseSignature)
signature_type The type of signature. (inherited from BaseSignature)
thumbprint The thumbprint of a certificate. (inherited from DigitalSignature)
top The top position of the signature. (inherited from BaseSignature)
width The width of the signature. (inherited from BaseSignature)
xad_es_type The XAdES type (DigitalSignature.x_ad_es_type). (inherited from DigitalSignature)

See Also