Options
(→SignatureAppearance Table) |
(→SignatureAppearance Table) |
||
Line 151: | Line 151: | ||
| class="op_param_name" | [[#Template|Template]] | | class="op_param_name" | [[#Template|Template]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies the custom template (not from the [[#Template|Template]]) table. Used if [[#HasTemplate|HasTemplate]] is <tt>'''true'''</tt>. | + | | Specifies the custom signature appearance template (not from the [[#Template|Template]]) table. Used if [[#HasTemplate|HasTemplate]] is <tt>'''true'''</tt>. |
|- | |- | ||
| class="op_param_name" | TemplateIdx | | class="op_param_name" | TemplateIdx | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies the index of the template in the [[#Template|Template]]) table. Used if [[#HasTemplate|HasTemplate]] is <tt>'''false'''</tt>. | + | | Specifies the index of the signature appearance template in the [[#Template|Template]]) table. Used if [[#HasTemplate|HasTemplate]] is <tt>'''false'''</tt>. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|} | |} |
Revision as of 00:04, 26 April 2016
Contents
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:
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:
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.
Default value: 0 | ||||||||||
LockAfterSigning | Boolean | Currently this value is not used.
Default value: false |
SignatureAppearance Table
Name | Type | Value |
---|---|---|
Certificate | String | Currently this value is not used.
Default value: Empty String |
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 | ||||||
---|---|---|---|---|---|---|---|---|
GraphicType | Integer | Specifies...
Possible values are:
Default value: 0 (None) | ||||||
GraphicName | String | Specifies...
Default value: Empty String | ||||||
TextDirection | Integer | Specifies...
Possible values are:
Default value: 0 (Auto) | ||||||
ShowName | Boolean | Specifies...
Default value: false | ||||||
ShowDate | Boolean | Specifies...
Default value: false | ||||||
ShowLocation | Boolean | Specifies...
Default value: false | ||||||
ShowReason | Boolean | Specifies...
Default value: false | ||||||
ShowDistinguishedName | Boolean | Specifies...
Default value: false | ||||||
ShowLabels | Boolean | Specifies...
Default value: false | ||||||
ShowLogo | Boolean | Specifies...
Default value: false | ||||||
ShowSubjectName | Boolean | Specifies...
Default value: false | ||||||
ShowEditorVersion | Boolean | Specifies...
Default value: false | ||||||
Name | String | Specifies...
Default value: Empty String |
TimeStamping Table
Name | Type | Value |
---|---|---|
Enabled | Boolean | Specifies...
Default value: false |
PresetID | String | Specifies...
Default value: Empty String |
Data | Dictionary | Specifies... |
Data Table
Name | Type | Value |
---|---|---|
URL | String | Specifies...
Default value: Empty String |
RequireAuth | Boolean | Specifies...
Default value: false |
User | String | Specifies...
Default value: Empty String |
Password | String | Specifies...
Default value: Empty String |