SignDocSignatureParameters Class

Parameters for signing a document. Use SignDocDocument.createSignatureParameters() or SignDocDocument.createSignatureParametersForTimeStamp() to create objects of this type. The available parameters depend both on the document type and on the signature field for which the SignDocSignatureParameters object has been created. All setters have a special value for one of their arguments which can be used for checking if the parameter can be set. SignDocDocument.addSignature() may fail due to invalid parameters even if all setters reported success as the setters do not check if there are conflicts between parameters. Which certificates are acceptable may be restricted by the application (by using csf_software and csf_hardware of integer parameter "SelectCertificate", blob parameters "FilterCertificatesByIssuerCertificate" and "FilterCertificatesBySubjectCertificate", and string parameters "FilterCertificatesByPolicy" and "FilterCertificatesBySubjectDN") and by the PDF document (certificate seed value dictionary). If no matching certificate is available (for instance, because integer parameter "SelectCertificate" is zero), SignDocDocument.addSignature() will throw SignDocNoCertificateException. If more than one matching certificate is available but csf_never_ask is specified in integer parameter "SelectCertificate"), SignDocDocument.addSignature() will throw SignDocAmbiguousCertificateException. To make the signature maximally meaningful, integer parameter "AddCertificates" should be ac_all (which is the default value) and integer parameter "AddRevocationInfo" should include #ari_add. Unless you need a specific signing method, you should leave integer parameter "Method" at its default value #m_default. If you select a specific signing method and that method is not allowed by the signature field's seed values, signing will fail. Unless you need a specific digest algorithm, you should leave integer parameter "DetachedHashAlgorithm" at its default value #dha_default. If you select a specific digest algorithm and that algorithm is not allowed by the signature field's seed values, signing will fail.

The following name parameters control the signing method and
related aspects of the signature:

-   DetachedHashAlgorithm (integer)
-   IgnoreSeedValues (integer)
-   Method (integer)
.

The following named parameters control the private key used for
signing:
-   Certificate (blob)
-   CertificatePrivateKey (blob)
-   GenerateECCKeyPair(string)
-   GenerateKeyPair (integer)
-   PKCS#12Password (string)
.

The following named parameters control rendering of the signature
image from biometric data:
-   BiometricData (blob)
-   PenWidth (integer)
-   RenderSignature (integer)
-   RenderWidth (integer)
-   SignatureColor (color)
.

The following named parameters put additional data into the
signature:
-   ContactInfo (string)
-   Filter (string)
-   Location (string)
-   Reason (string)
-   Signer (string)
-   Timestamp (string)
.

The following named parameters provide texts for the appearance
of a signature in PDF documents:
-   Adviser (string)
-   Comment (string)
-   ContactInfo (string)
-   Location (string)
-   Reason (string)
-   Signer (string)
-   SignTime (string)
-   Text1 through Text9 (string)
.

 The following parameters control how a signed signature
 field in a PDF document will look like(parameters marked with *
can be overridden with blob parameter "Template") :
-   FontName(string) *
-   FontSize(length) *
-   Image (blob)
-   ImageDPI(integer)
-   ImageHAlignment (integer) *
-   ImageMargin (length) *
-   ImageTransparency (integer) *
-   ImageVAlignment (integer) *
-   SignatureColor (color)
-   Template (blob)
-   TextColor (color) *
-   TextHAlignment (integer) *
-   TextHMargin (length) *
-   TextPosition (integer) *
-   TextVAlignment (integer) *


The following named parameters control the signing certificate:
-   Certificate (blob)
-   PKCS#12Password (string)
.

The following named parameters are used for generating a self-signed
certificate on the fly (you also need to set at least one parameter
for the private key):
-   CertificateSigningAlgorithm (integer)
-   CommonName (string)
-   Country (string)
-   Locality (string)
-   Organization (string)
-   OrganizationUnit (string)
.

The following named parameters are used for putting biometric data
(handwritten signature) into the signature:
-   BiometricData (blob)
-   BiometricEncryption (integer)
-   BiometricHashLocation(integer)
-   BiometricKey (blob)
-   BiometricKeyPath (string)
-   BiometricPassphrase (string)
.

The following named parameters control the certificate selection dialog:
-   FilterCertificatesByIssuerCertificate (blob)
-   FilterCertificatesByPolicy (string)
-   FilterCertificatesBySubjectCertificate (blob)
-   FilterCertificatesBySubjectDN (string)
-   SelectCertificate (integer)
-   SelectCertificateMessage (string)
-   SelectCertificateTitle (string)
.

The following named parameters control RFC 3161 timestamps:
-   TimeStampClientCertificatePath (string)
-   TimeStampClientKeyPath (string)
-   TimeStampHashAlgorithm (integer)
-   TimeStampRetries (integer)
-   TimeStampServerPassword (string)
-   TimeStampServerTimeout (integer)
-   TimeStampServerURL (string)
-   TimeStampServerUser (string)
-   TimeStampSize (integer)
-   TimeStampUserAgent (string)
.

The following named parameters put additional certificates and
revocation information into the signature:
-   AddCertificates (integer)
-   AddRevocationInfo (integer)
-   IntermediateCertificate (blob)
.

The following named parameters do not fall into the above categories:
-   OutputPath (string)
-   Optimize (integer)
-   PDFAButtons (integer)

Inheritance Hierarchy

SystemObject
de.softpro.signdocsdkSignDocSignatureParameters

Namespace: de.softpro.signdocsdk
Assembly: SPSignDoc_4.3_DotNetLib (in SPSignDoc_4.3_DotNetLib.dll) Version: 1.0.6773.37566

Syntax

Copy

public sealed class SignDocSignatureParameters : IDisposable

The SignDocSignatureParameters type exposes the following members.

Methods

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().

Profile	Value
""	#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".

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():

Profile	Value
""	#ti_signer/#tg_master, #ti_sign_time/#tg_master
"image"	(empty)

See also blob parameter "Template".

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

Releases all resources used by the SignDocSignatureParameters

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