SignDoc Class

classSignDoc : 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

Uses types

CancelProc CredentialDataFmt CredentialStorageFmt DigestCategory DisplayTraits Document ProgressMonitor Rect SignDoc SignatureFieldID SignatureType

Constructor & Destructor Documentation

SignDoc(SignDocrhs, InternalConstructsignifier)

Parameters

rhs: SignDoc
signifier: InternalConstruct

SignDoc()

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

~SignDoc()

Property Documentation

CredentialDataFmtCredentialDataFormat[get, set]

DigestCategoryDigestCategory[get, set]

SignatureTypeDocSignType[get, set]

SignatureFieldIDFieldID[get, set]

stringFieldName[get, set]

stringOutputPath[get, set]

uintSignatureBoxPageNumber[get, set]

RectSignatureBoxRectangle[get, set]

Member Function Documentation

voidAddDigitalSignature(Documentdocument)

Parameters

document: Document

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.

static SignDocConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

SignDoc

voidCreateCancelProc(CancelProccancelProc)

Parameters

cancelProc: CancelProc

Returns:

void

Create Cancel Callback

voidCreateProgressMonitor(ProgressMonitorprogMon)

Parameters

progMon: ProgressMonitor

Returns:

void

Create Progress Monitor

voidDispose()

Returns:

void

voidDisposeChildren()

Returns:

void

voidSetFieldObject(intaValue, intbValue)

Parameters

aValue: int: a value of the CosObject.
bValue: int: b value of the CosObject.

Returns:

void

Set the form field CosObject option.

voidSetNonPfxPassPhrase(stringpassPhrase, uintpassphraseSize, CredentialStorageFmtstorageFmt)

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.

voidSetNonPfxPrivateKey(stringprivateKey, uintkeySize, CredentialStorageFmtstorageFmt)

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

voidSetNonPfxSignerCert(stringsignerCert, uintcertSize, CredentialStorageFmtstorageFmt)

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.

voidSetPfxCredentials(stringcredentials, CredentialStorageFmtstorageFmt)

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.

voidSetPfxPassPhrase(stringpassphrase, uintpassphraseSize, CredentialStorageFmtstorageFmt)

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.

voidSetSignerInfo(stringlogoFilePath, floatlogoOpacity, stringname, stringlocation, stringreason, stringcontactInfo, DisplayTraitsdisplayTraits)

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.