Options

PDF Editor Layer > Operations > op.document.addDigitalSignature > Options

Options Table

Name	Type	Value
Certificate	String	Specifies the certificate in the system store. Represented by hexadecimal string that contains SHA1 hash of the certificate. Not used if UseFileCertificate is TRUE or DigiSigType is 4 (Timestamp). Default value: Empty String
FileCertificate	String	Specifies the path to the file certificate. Not used if UseFileCertificate is FALSE or DigiSigType is 4 (Timestamp). Default value: Empty String
UseFileCertificate	Boolean	Specifies whether the file certificate specified by FileCertificate will be used for signing the document. If false, certificate from the system storage, specified by Certificate, will be used for signing the document. This field is not used if DigiSigType is 4 (Timestamp). Default value: false
SignatureAppearance	Dictionary	Specifies the details of the signature appearance.
TimeStamping	Dictionary	Specifies the timestamping parameters.
DigiSigType	Integer	Specifies the type of the signature. Possible values are: 0 (Unknown) Invalid value. 1 (Approval) Approval signature. 2 (Certification) Certification signature. 4 (Timestamp) Timestamp signature. Default value: 0 (Unknown)
FieldName	String	Specifies the name of the field in the document, if this field should be used for digital signature. Default value: Empty String
PageNumber	Integer	If the new field should be created in the document for digital signing, this value specifies the page number where this field should be placed. Used with SignatureBox and RotationFactor. Not used if FieldName contains the name of the existing field in the document. Default value: 1
SignatureBox	Dictionary	If the new field should be created in the document for digital signing, this dictionary specifies coordinates of this newly created field on the page whose number specified by PageNumber. Not used if FieldName contains the name of the existing field in the document.
RotationFactor	Integer	If the new field should be created in the document for digital signing, this value specifies the rotation of this field. Used with PageNumber and SignatureBox. Not used if FieldName contains the name of the existing field in the document. Valid values are: 0 No rotation. 1 90 degrees rotation. 2 180 degrees rotation. 3 270 degrees rotation. Default value: -1 (Invalid)
CertificatePassword	String	Specifies the password for the certificate specified in Certificate or FileCertificate Default value: Empty String
AskDestinationFileName	Boolean	Specifies whether the user will be asked about the destination file name of the resulting signed file using UI dialog. If false, DestinationFileName will be used. If false and DestinationFileName is empty, the current file of the document will be overwritten with the signed version. Default value: false
DestinationFileName	String	Specifies the destination file name of the resulting signed file. Used if AskDestinationFileName is false. If AskDestinationFileName is false and this value is empty, the current file of the document will be overwritten with the signed version. Default value: Empty String
DocMDP	Integer	Specifies the permissions granted for signed document. 1 No changes to the document shall be permitted; any change to the document shall invalidate the signature. 2 Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature. 3 Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature. Default value: 0

SignatureAppearance Table

Name	Type	Value
Reason	String	Specifies the reason for signing document, such as 'I agree…'. Not used for timestamp signatures. Default value: Empty String
Location	String	Specifies the CPU host name or physical location of the signing. Default value: Empty String
ContactInfo	String	Specifies information provided by the signer to enable a recipient to contact the signer to verify the signature. Not used for timestamp signatures. Default value: Empty String
HasTemplate	Boolean	Specifies whether the Template will be used. Default value: false
Template	Dictionary	Specifies the custom signature appearance template (not from the Template) table. Used if HasTemplate is true.
TemplateIdx	Integer	Specifies the index of the signature appearance template in the Template) table. Used if HasTemplate is false. Default value: -1

Template Table

Name	Type	Value
Name	String	Specifies the unique name of the signature appearance template. Default value: Empty String
Template Data	Dictionary	Specifies the parameters of the signature appearance template.

Template Data Table

Name	Type	Value
GraphicType	Integer	Specifies the type of the graphic used in the signature appearance. Possible values are: 0 (None) No graphic will be used in the signature appearance. 2 (XForm) Graphic specified by HasTemplate will be used in the signature appearance. Default value: 0 (None)
GraphicName	String	Specifies the path to the image file of supported format. Used if GraphicType is 1 (XForm). Default value: Empty String
TextDirection	Integer	Specifies the text direction in the signature appearance. Possible values are: 0 (Auto) Automatic direction of the text in the signature appearance. 1 (LeftToRight) Direction of the text in the signature appearance is Left-to-Right. 2 (RightToLeft) Direction of the text in the signature appearance is Right-to-Left. Default value: 0 (Auto)
ShowName	Boolean	Specifies whether the name of the signer will be displayed. Default value: false
ShowDate	Boolean	Specifies whether the date of the signer will be displayed. Default value: false
ShowLocation	Boolean	Specifies whether the Location will be displayed. Default value: false
ShowReason	Boolean	Specifies whether the Reason will be displayed. Default value: false
ShowDistinguishedName	Boolean	Specifies whether the distinguished name of the signer will be displayed. Default value: false
ShowLabels	Boolean	Specifies whether the labels will be displayed for the information fields. Default value: false
ShowLogo	Boolean	Specifies whether the application logo will be displayed on the signature's background. Default value: false
ShowSubjectName	Boolean	Specifies whether the subject name will be displayed. Default value: false
ShowEditorVersion	Boolean	Specifies whether the application version will be displayed on the signature's background. Default value: false

TimeStamping Table

Name	Type	Value
Enabled	Boolean	Specifies whether the timestamp should be added to the digital signature. Used when DigiSigType is 1 (Approval) or 2 (Certification). Default value: false
PresetID	String	This value must be empty. Default value: Empty String
TimeStamping Data	Dictionary	Specifies the timestamp data for digital signature. Used when DigiSigType is 4 (Timestamp) or when DigiSigType is 1 (Approval) or 2 (Certification) and Enabled is true

Timestamp Data Table

Name	Type	Value
URL	String	Specifies the URL to the timestamp server. Default value: Empty String
RequireAuth	Boolean	Specifies whether the timestamp server requires authentication. Default value: false
User	String	Specifies the user name for timestamp server. Used if RequireAuth is true. Default value: Empty String
Password	String	Specifies the password for timestamp server. Used if RequireAuth is true. Default value: Empty String