SignDoc SDK (.NET without exceptions)  5.0.0
SignDocSignature Class Reference

Information about a signature field returned by SignDocDocument.getSignature(). More...

Public Member Functions

 ~SignDocSignature ()
 Destructor. More...
 
 !SignDocSignature ()
 Finalizer. More...
 
string getFieldName ()
 Get the name of the signature field. More...
 
int getFieldPage ()
 Get the page number of the signature field. More...
 
SignatureType getSignatureType ()
 Get the type of the signature. More...
 
SigningMethod getMethod ()
 Get the signing method. More...
 
int getClearedIndex ()
 Get the index of the signature at which this signature has been removed. More...
 
int getDocMDP ()
 Get the DocMDP P value of a certification signature. More...
 
int getLockMDP ()
 Get the lock MDP value. More...
 
byte[] getSigningCertificate ()
 Get the signing certificate as DER-encoded blob. More...
 
string getSignerCommonName ()
 Get the common name from the signing certificate. More...
 
string getSignerEmail ()
 Get the email address from the signing certificate. More...
 
string getTimeStamp ()
 Get the time stamp of the signature. More...
 
int getChangeCount ()
 Get the number of changes that have been made after this signature. More...
 
SignDocChange getChange (int aIndex)
 Get a SignDocChange object for a change. More...
 
BiometricEncryption getBiometricEncryption ()
 Get the encryption method used for biometric data of the signature field. More...
 

Detailed Description

Information about a signature field returned by SignDocDocument.getSignature().

Constructor & Destructor Documentation

Destructor.

Finalizer.

Member Function Documentation

BiometricEncryption getBiometricEncryption ( )

Get the encryption method used for biometric data of the signature field.

Note
SignDocVerificationResult.getBiometricEncryption() provides better reporting of errors.
Returns
The encryption method.
See also
getChange()
SignDocChange getChange ( int  aIndex)

Get a SignDocChange object for a change.

Parameters
[in]aIndexZero-based index of the change.
Returns
A SignDocChange object for the change or null if aIndex is out of range.
See also
getChangeCount()
int getChangeCount ( )

Get the number of changes that have been made after this signature.

For PDF documents, you can find out what changes have been made to the document between this signature and the next one (or after the last signature if this is the last signature).

Computing the changes can be expensive.

Changes are not reported in any particular order; before presenting them to a user, you should group them.

Detecting and categorizing changes is work in progress. Moreover, it will never be bug-compatible with Adobe products.

Returns
The number of changes.
See also
getChange()
int getClearedIndex ( )

Get the index of the signature at which this signature has been removed.

This function always returns -1 for TIFF document.

Returns
-1 if the signature has not been removed, that is, the field is still signed; a non-negative value (greater than the index of gthis signature) indicating the index of the signature at which this signature was found to have been removed. If the return value equals the number of signatures (as returned by SignDocDocument.getSignatureCount()), this signature has been removed after performing the last signature.
See also
SignDocDocument.clearSignature(), SignDocDocument.getSignature(), SignDocDocument.getSignatureCount()
int getDocMDP ( )

Get the DocMDP P value of a certification signature.

The MDP P value specifies what modifications to the document are allowed by the certification signature.

Returns
-1 if this signature is not a certification signature, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted. For TIFF documents, this function always returns -1.
See also
getLockMDP()
string getFieldName ( )

Get the name of the signature field.

Returns
The name of the signature field.
int getFieldPage ( )

Get the page number of the signature field.

Returns
The 1-based page number or 0 if the page number is unknown.
int getLockMDP ( )

Get the lock MDP value.

The lock MDP value specifies what modifications to the document are allowed by the signature lock dictionary.

Returns
-1 if the signature does not have a lock MDP value, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted. For TIFF documents, this function always returns -1.
See also
getDocMDP(), SignDocField.getLockMDP()
SigningMethod getMethod ( )

Get the signing method.

If the output is SigningMethod.DigSigCadesRFC3161, the signature is a document time stamp.

Returns
The signing method, see enum SigningMethod. SigningMethod.Default is never returned.
SignatureType getSignatureType ( )

Get the type of the signature.

Returns
The type of the signature.
string getSignerCommonName ( )

Get the common name from the signing certificate.

Returns
The common name from the signing certificate, empty on error.
string getSignerEmail ( )

Get the email address from the signing certificate.

Returns
The email address from the signing certificate, empty on error.
byte [] getSigningCertificate ( )

Get the signing certificate as DER-encoded blob.

Returns
The DER-encoded signing certificate.
Note
The WinRT component returns null instead of an empty blob.
string getTimeStamp ( )

Get the time stamp of the signature.

You have to use SignDocDocument.verifySignature() to find out whether the time stamp can be trusted.

Returns
The time stamp of the signature in ISO 8601 format: "yyyy-mm-ddThh:mm:ss" with optional timezone. Empty on error.

The documentation for this class was generated from the following file: