| SignDocSignatureParameters Methods |
The SignDocSignatureParameters type exposes the following members.
| Name | Description | |||||||
|---|---|---|---|---|---|---|---|---|
| addTextItem | Add another string to be displayed, top down.
For DigSig signature fields, this function adds another string to
the appearance stream of PDF documents.
The first call clears any default strings.
The default values depend on the profile passed to
SignDocDocument.createSignatureParameters().
| |||||||
| addTextItem2 | Add another string to be displayed, top down, with
paragraph direction.
For DigSig signature fields, this function adds another string to
the appearance stream of PDF documents.
The first call clears any default strings.
The default values depend on the profile passed to
SignDocDocument.createSignatureParameters():
| |||||||
| clearTextItems | Remove all strings that were to be displayed.
addTextItem() cannot remove the default strings without adding
a new string. This function does.
See also blob parameter "Template".
| |||||||
| destroy | Destroy this object, overwriting sensitive data.
After calling this method, all methods of this object will throw.
| |||||||
| Dispose | ||||||||
| getAvailableMethods | Get a bitset indicating which signing methods are available
for this signature field.
| |||||||
| getErrorMessage | Get an error message for the last function call. | |||||||
| getStateBlob | Get the status of a parameter. | |||||||
| getStateCol | Get the status of a parameter. | |||||||
| getStateInt | Get the status of a parameter. | |||||||
| getStateLen | Get the status of a parameter. | |||||||
| getStateStr | Get the status of a parameter. | |||||||
| getTemplate | Get an XML document specifying the current layout.
This function can be used for debugging and for reporting bugs.
This function will fail if the "Template" blob parameter is invalid.
| |||||||
| setBlob | Set a blob parameter.
| |||||||
| setColor | Set a color parameter.
| |||||||
| setECDSA | Set an object which will compute an ECDSA signature.
By default, ECDSA signatures are computed internally which means
that the private key must be available on this machine.
Requirements for string parameters:
- GenerateECCKeyPair must not be set
.
Requirements for integer parameters:
- GenerateKeyPair must not be set
- SelectCertificate must be zero (which is the default value)
.
Requirements for blob parameters:
- Certificate must not be set
- CertificatePrivateKey must not be set
.
setRSA() and setPKCS7() must not have been called
| |||||||
| setInteger | Set an integer parameter.
| |||||||
| setLength | Set a length parameter. | |||||||
| setPKCS7 | Set an object which will create a PKCS #7 or CAdES signature. By default, PKCS #7 and CAdES signatures are handled internally which means that the private key must be available on this machine.Requirements for string parameters: - CommonName must not be set - Country must not be set - GenerateECCKeyPair must not be set - Locality must not be set - Organization must not be set - OrganizationUnit must not be set Requirements for integer parameters: - GenerateKeyPair must not be set - Method must be #m_digsig_pkcs7_detached, #m_digsig_pkcs7_sha1, or #m_digsig_cades_detached - SelectCertificate must be zero (which is the default value) Requirements for blob parameters: - Certificate must not be set - CertificatePrivateKey must not be set setECDSA() and setRSA() must not have been called The SignPKCS7 interface is quite hard to use, please use setRSA() and the SignRSA interface or setECDSA() and the SignECDSA interface instead. | |||||||
| setRSA | Set an object which will compute an RSA signature.
By default, RSA signatures are computed internally which means
that the private key must be available on this machine.
Requirements for string parameters :
- GenerateECCKeyPair must not be set.
Requirements for integer parameters:
- GenerateKeyPair must not be set
- SelectCertificate must be zero (which is the default value)
Requirements for blob parameters:
- Certificate must not be set
- CertificatePrivateKey must not be set
setECDSA() and setPKCS7() must not have been called
| |||||||
| setString | Set a string parameter.
| |||||||
| setTextItemDirection | Set the paragraph direction of text items.
This function sets the paragraph direction of all existing text items
matching @a aItem.
See also blob parameter "Template".
|