Click or drag to resize
SignDocSignatureParameters Methods

The SignDocSignatureParameters type exposes the following members.

Methods
  NameDescription
Public methodaddTextItem
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().
ProfileValue
""#ti_signer/#tg_master, #ti_sign_time/#tg_master
"image"(empty)
The paragraph direction is 0 which is treated like #tid_ltr. See also blob parameter "Template".
Public methodaddTextItem2
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():
ProfileValue
"" #ti_signer/#tg_master, #ti_sign_time/#tg_master
"image"(empty)
See also blob parameter "Template".
Public methodclearTextItems
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".
Public methoddestroy
Destroy this object, overwriting sensitive data. After calling this method, all methods of this object will throw.
Public methodDispose
Public methodgetAvailableMethods
Get a bitset indicating which signing methods are available for this signature field.
Public methodgetErrorMessage
Get an error message for the last function call.
Public methodgetStateBlob
Get the status of a parameter.
Public methodgetStateCol
Get the status of a parameter.
Public methodgetStateInt
Get the status of a parameter.
Public methodgetStateLen
Get the status of a parameter.
Public methodgetStateStr
Get the status of a parameter.
Public methodgetTemplate
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.
Public methodsetBlob
Set a blob parameter.
Public methodsetColor
Set a color parameter.
Public methodsetECDSA
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
Public methodsetInteger
Set an integer parameter.
Public methodsetLength
Set a length parameter.
Public methodsetPKCS7

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.
Public methodsetRSA
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
Public methodsetString
Set a string parameter.
Public methodsetTextItemDirection
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".
Top
See Also