Name |
Values |
Description |
PDFv3 |
---|---|---|---|
Enabled |
Boolean |
If this property is False, digital signing is not used and no other properties need to be specified. Default = False |
*Enable |
Store |
Defines which stored certificate should be used. Default = 0 (System) |
(new) |
|
0 (System) |
The default user's stored system certificate will be used. |
||
1 (File) |
An external PFX file must be specified. |
||
Hash |
String |
This property is only used when the Store property is set to 0 (System), in which case it identifies the certificate to be used for signing the document by its thumbprint (hash). When Store value is 1 (File), this property is not used. The format is a quote string of comma delimited 2-digit hex codes, e.g. //PDFX,DigiSig.Hash,”d8,62,d4,91,bf,01,bf,fb,a1,86,12,ae,07,57,4a,95,dc,02,d4" You can obtain the necessary codes from your Certificate Manager app (certmgr.msc) – double-click the certificate, click details, then scroll down to Thumbprint. |
(new) |
PFXFile |
String |
When Store value is 1 (File), this specifies the PFX file which contains the digital signature for signing the document. When Store value is 0 (System), this property is not used. Warning: we have found this somewhat difficult to get working; if you encounter problems too, our recommendation is to load the PFXFile into the Certificate Store and then use Store,0 |
(same) |
PFXPassword |
String |
When Store value is 1 (File), this specifies the password for the PFX file. When Store value is 0 (System), this property is not used. |
(same) |
Reason |
String |
These properties define additional text properties to be included with the digital signature within the PDF document. Default values: empty string. |
(same) |
Location |
(same) |
||
Contact |
*ContactInfo |
||
Graphic |
Defines how the graphic (left) portion of the signature fields should be displayed. Default = 2 (Name) |
(new) |
|
0 (None) |
This will not be used, and information about the digital signature will be placed in the entire area of the signature field. |
||
1 (Image) |
The image file specified by GraphicFileName will be used. |
||
2 (Name) |
The signer's name as in the certificate will be used. |
||
GraphicFileName |
String |
When Graphic is Image, this is the fully qualified path name for the image to be used on the signature. This image can be any one of the supported image formats. |
Image |
ShowFlags |
Integer |
A combination of flags which define how the signature field should look. See details below. |
Flags |
Page |
Integer |
Zero based page number on which the digital signature should be placed. A value of -1 for this property places the signature on the last page of the document. Default = -1 |
(same) |
Left |
Integer |
Defines the left position of the signature graphic (relative to the top left corner of the page). Value specified in tenths of millimeters. Default = 254 (1 inch) |
(same) |
Top |
Integer |
Defines the top position of the signature graphic (relative to the top left corner of the page). Value specified in tenths of millimeters. Default = 254 (1 inch) |
(same) |
Width |
Integer |
Defines the width of the signature graphic. Value specified in tenths of millimeters. Default = 508 (2 inches) |
(same) |
Height |
Integer |
Defines the width of the signature graphic. Value specified in tenths of millimeters. Default = 168 (2/3 inch) |
(same) |
ShowFlags
Defines attributes signature appearance. It can be combination of the following values:
Values |
Description |
---|---|
1 |
Show the name of the signer (taken from the certificate) |
2 |
Show the signing date |
4 |
Show the Location property text |
8 |
Show the Reason property text |
16 |
Show the Distinguished Name field (taken from the certificate) |
32 |
Prepend each field with its corresponding label (e.g. Name: MicroSabio) |
Examples
//;Enable digital signature
//PDFX,DigiSig.Enabled,True
//;Select certificate from the system store
//PDFX,DigiSig.Store,System
//PDFX,DigiSig.Hash,"d8,32,d4,91,af,01,bf,fb,a1,86,0c,a9,28,6f,57,4a,95,dc,02,d4"
//;Enable and specify a timestamp server
//PDFX,DigiSig,TimeStamp.Enable,True
//PDFX,DigiSig,TimeStamp.ServerURL,http://timestamp.comodoca.com/rfc3161
//PDFX,DigiSig.ServerName,Comodo
//;Specify data for the information fields
//PDFX,DigiSig.Reason,Sample reason
//PDFX,DigiSig.Location,Sample location
//PDFX,DigiSig.Contact,Sample contact
//PDFX,DigiSig.Graphic,Name
//;put signature on last page of doc
//PDFX,DigiSig.Page,-1
//;set location for the signature image (tenths of millimeters)
//PDFX,DigiSig.Top,2000
//PDFX,DigiSig.Left,700
//;specify we want to show all the fields in the signature image
//PDFX,DigiSig.ShowFlags,63
Compatibility
Digital signatures were not very usable in PDFXv3, due to the lack of a TimeStamp option (now included) and the ability to specify the signature properties as runtime. Under PDFXv5+, this feature is quite usable, although in order for the signatures to be automatically recognized by Acrobat, you’ll have to obtain your signing certificate from an Adobe-authorized provider.
In PDFXv5+, the property name has been shorted from Security.DigiSig to DigiSig.