| SignDocSignatureParameterssetBlob Method |
Set a blob parameter.
Namespace:
de.softpro.signdocsdk
Assembly:
SPSignDoc_4.3_DotNetLib (in SPSignDoc_4.3_DotNetLib.dll) Version: 1.0.6773.37566
Syntax
Remarks
Available blob parameters are:
- BiometricData - The biometric data must either be in
SignDoc format (created by the Serialize()
function of SDSIGNATUREMANAGER) or in
SignWare format (created by
SPFlatFileCreateFromSignature()).
The biometric data is stored in the document
(see integer parameter "BiometricEncryption")
and will be used for rendering the signature image
if integer parameter "RenderSignature" is non-zero
(unless a signature image is specified by blob
parameter "Image").
- BiometricKey - The public key (be_rsa) or the AES key (be_binary)
for encrypting the biometric data. See also
string parameter "BiometricKeyPath" and
@ref signdocshared_biometric_encryption.
- Certificate - The certificate for the signature.
The blob must contain
a serialized X.509 certificate (DER or PEM) and
blob parameter "CertificatePrivateKey" must contain
the private key for that certificate.
Alternatively, for PKCS #7 signatures and CAdES
detached signatures, the blob may contain the
certificate and its private key in PKCS #12 format;
string parameter "PKCS#12Password" contains the
password for extracting the private key.
- CertificatePrivateKey -
The private key for the (self-signed) certificate
in PKCS #1 format(DER or PEM) for RSA or
in PKCS #1 format(DER or PEM) for RSA or
in SEC 1 format, traditional format, or PKCS #8
format(DER or PEM) for ECDSA.
If a certificate is passed
in blob parameter "Certificate", this parameter
must contain the private key for that certificate.
If a self - signed certificate is to be generated,
the private key can be either set with this parameter
or generated with integer parameter
"GenerateKeyPair" or with string parameter
"GenerateECCKeyPair".
- FilterCertificatesByIssuerCertificate - Acceptable issuer certificates.
Setting this parameter adds the specified
DER-encoded certificate to a list of acceptable
issuer certificates.
Pass null to clear the list.
A PDF document may contain (in its certificate seed
value dictionaries) additional restrictions
for acceptable issuer certificates.
A signer certificate is acceptable for the rule
defined by this parameter if it chains up to any
of the certificates in the list of acceptable
issuer certificates.
SignDocDocument.addSignature() will fail if no
matching certificate is available for signing.
Note that csf_software and/or csf_hardware must
be included in integer parameter "SelectCertificate"
to make certificates available at all.
- FilterCertificatesBySubjectCertificate - Acceptable certificates.
Setting this parameter adds the specified
DER-encoded certificate to a list of acceptable
certificates.
Pass null to clear the list.
A PDF document may contain (in its certificate seed
value dictionaries) additional restrictions
for acceptable certificates.
SignDocDocument.addSignature() will fail if no
matching certificate is available for signing.
Note that csf_software and/or csf_hardware must
be included in integer parameter "SelectCertificate"
to make certificates available at all.
- Image - The signature image.
The image can be in BMP, JPEG, PNG, or TIFF format.
If no image is set (or rendered, see integer
parameter "RenderSignature"), the signature field
may or may not show an image computed from the
biometric data, depending on the document
type and signature field type.
This parameter overrides integer parameter
"RenderSignature".
See also integer parameters "ImageDPI",
"ImageTransparency", and blob parameter
"Template".
- IntermediateCertificate - An intermediate certificate for
the signature.
The blob must contain a DER-encoded X.509
certificate or one or more PEM-encoded X.509
certificates.
setBlob() calls with name "IntermediateCertificate"
are cumulative.Intermediate certificates can
also be provided in the PKCS #12 blob passed to
blob parameter "Certificate".
See also integer parameter "AddCertificates".
- Template -
An XML document specifying the layout of the
appearance of a signature in PDF documents.
The XML document must conform to
SignatureTemplate.dtd
SignatureTemplate.dtd,
which see for details.
SignatureTemplate.dtd, which see for details.
You can control the layout of the appearance
of the signature by
-using the default values provided by
SignDocDocument.createSignatureParameters(), or
-using only string parameters(such as
"FontName"), integer parameters(such as
"TextPosition"), length parameters
(such as "ImageMargin"), and color parameters
(such as "TextColor") or
-using only blob parameter "Template", or
-a mixture of the above.
.
Initial values for the parameters are provided by
SignDocDocument.createSignatureParameters().
If blob parameter "Template" is set, text items
added by addTextItem() and friends are ignored,
but other parameters provide default values for
attributes not used in the XML document.
See Also