SignDoc Class Documentation

class SignDoc : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Implementation of the PDF SignDoc function.

Use the SignDoc object to digitally sign a document

Referenced by

SignDoc

Constructor & Destructor Documentation

SignDoc

SignDoc()

Creates an empty SignDoc object and initializes memory for its parameters.

Property Documentation

CredentialDataFormat

CredentialDataFmt CredentialDataFormat[get, set]

DigestCategory

DigestCategory DigestCategory[get, set]

DocSignType

SignatureType DocSignType[get, set]

FieldID

SignatureFieldID FieldID[get, set]

FieldName

string FieldName[get, set]

OutputPath

string OutputPath[get, set]

SignatureBoxPageNumber

uint SignatureBoxPageNumber[get, set]

SignatureBoxRectangle

Rect SignatureBoxRectangle[get, set]

Member Function Documentation

AddDigitalSignature

void AddDigitalSignature(Document document)

Parameters

document: Document

The Document to be digitally signed.

Returns:

void

Adds a digital signature using the specified credentials.

If the document has not been previously signed, signs and saves the entire document. If the document has been previously signed, signs and saves only the portions of the document that have changed. If the document has been previously signed and the path to which the file is saved is NULL or the same as the path specified by the parameter, doc, signs and copies the document, saving only the portions of the document that have changed.

AddSigPolicy

int AddSigPolicy(string oid)

Parameters

oid: string

Object Identifier (OID) of the signature policy to add.

Returns:

int

- The number of signature policies added to the signature.

Add a signature policy to the PAdES signature being generated. Signature policies may be applied to PAdES signatures, only. The signature type must be set to PADES prior to adding a policy.

AddSigPolicyQualifierURI

void AddSigPolicyQualifierURI(string uri)

Parameters

uri: string

URI pointing to the signature policy document.

Returns:

void

Qualify an existing signature policy with a Signature Policy URI (SPuri) qualifier. A policy must be added via AddSigPolicy prior to calling this method. A signature policy may be qualified by no more than one policy qualifier.

AddSigPolicyQualifierUserNotice

void AddSigPolicyQualifierUserNotice(string displayText, string org, System.Collections.Generic.IList< System.Int64 > noticeNos)

Parameters

displayText: string

Text to display to the user when the signature is verified.

org: string

Organization that prepared the notice.

noticeNos: System.Collections.Generic.IList< System.Int64 >

Group of integers that identify textual statements prepared by the organization.

Returns:

void

Qualify an existing signature policy with a Signature Policy UserNotice (SPUserNotice) qualifier. A policy must be added via AddSigPolicy prior to calling this method. A signature policy may be qualified by no more than one policy qualifier. The displayText and org attributes can be defined independent of each other. However, a valid org attribute must be defined in order to qualify a PAdES signature policy with the noticeNos attribute.

CreateCancelProc

void CreateCancelProc(CancelProc cancelProc)

Parameters

cancelProc: CancelProc

The CancelProc to receive cancel callbacks during signing.

Returns:

void

Creates and registers a cancel callback for the signing operation.

CreateProgressMonitor

void CreateProgressMonitor(ProgressMonitor progMon)

Parameters

progMon: ProgressMonitor

The ProgressMonitor to receive progress callbacks during signing.

Returns:

void

Creates and registers a progress monitor for the signing operation.

Dispose

void Dispose()

Returns:

void

SetFieldObject

void SetFieldObject(int aValue, int bValue)

Parameters

aValue: int

a value of the CosObject.

bValue: int

b value of the CosObject.

Returns:

void

Set the form field CosObject option.

SetNonPfxPassPhrase

void SetNonPfxPassPhrase(string passPhrase, uint passphraseSize, CredentialStorageFmt storageFmt)

Parameters

passPhrase: string

Passphrase used to encrypt Non-PFX private key. Should be set to NULL if unencrypted.

passphraseSize: uint

Passphrase size in bytes. Shall be set to 0 if private key is unencrypted or passphrase is stored on disk.

storageFmt: CredentialStorageFmt

Storage format for passphrase.

Returns:

void

Set the passphrase used to decrypt Non-PFX credentials.

Note: The passphrase provided must use the exact same character encoding used to encrypt the private key. The application makes no effort whatsoever to re-encode the same.

SetNonPfxPrivateKey

void SetNonPfxPrivateKey(string privateKey, uint keySize, CredentialStorageFmt storageFmt)

Parameters

privateKey: string

Private key.

keySize: uint

Size of private key in bytes. Shall be set to 0 if key is stored on disk.

storageFmt: CredentialStorageFmt

Storage format for private key.

Returns:

void

Set the private key for Non-PFX credentials..

SetNonPfxSignerCert

void SetNonPfxSignerCert(string signerCert, uint certSize, CredentialStorageFmt storageFmt)

Parameters

signerCert: string

Signer certificate

certSize: uint

Size of signer certificate in bytes. Shall be set to 0 if certificate is stored on disk.

storageFmt: CredentialStorageFmt

Storage format for the signer certificate.

Returns:

void

Set the signer certificate for Non-PFX credentials.

SetPfxCredentials

void SetPfxCredentials(string credentials, CredentialStorageFmt storageFmt)

Parameters

credentials: string

Credentials in PFX/PKCS#12 file format.

storageFmt: CredentialStorageFmt

Storage format for the signer certificate. (Only OnDisk is allowed for this option)

Returns:

void

Set PFX/PKCS#12 credentials.

SetPfxPassPhrase

void SetPfxPassPhrase(string passphrase, uint passphraseSize, CredentialStorageFmt storageFmt)

Parameters

passphrase: string

Passphrase used to encrypt PFX/PKCS#12 credentials. Shall be set to NULL if credentials are unencrypted.

passphraseSize: uint

Passphrase size in bytes. Shall be set to 0 if PFX credentials are unencrypted or passphrase is stored on disk.

storageFmt: CredentialStorageFmt

Storage format for PFX/PKCS#12 credentials.

Returns:

void

Set the passphrase used to decrypt PFX/PKCS#12 credentials. Note: The passphrase provided must use the exact same character encoding used to encrypt the PFX credentials. The application makes no effort whatsoever to re-encode the same.

SetSignerInfo

void SetSignerInfo(string logoFilePath, float logoOpacity, string name, string location, string reason, string contactInfo, DisplayTraits displayTraits)

Parameters

logoFilePath: string

Image to display as part of signature appearance.

logoOpacity: float

Opacity of image to display as part of signature appearance.

name: string

Name of the person or authority signing the document.

location: string

CPU host name or physical location of the signing.

reason: string

Reason for signing the document.

contactInfo: string

Information provided by the signer to enable recipients to contact signer for signature verification.

displayTraits: DisplayTraits

Fields to display as part of signature appearance.

Returns:

void

Set Signer Info.