SetSignatureValidationMark Method (GdPicturePDF)

In This Topic

Specifies whether the validity of the signature will be displayed using the corresponding graphic icon (validation mark) after the signing of the currently loaded PDF document. The predefined icon, that represents the current validity of the signature, is subsequently drawn within the signature's bounding box after the successful signing.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function SetSignatureValidationMark( _
   ByVal ShowValidationMark As Boolean _
) As GdPictureStatus

public GdPictureStatus SetSignatureValidationMark( 
   bool ShowValidationMark
)

public function SetSignatureValidationMark( 
    ShowValidationMark: Boolean
): GdPictureStatus;

public function SetSignatureValidationMark( 
   ShowValidationMark : boolean
) : GdPictureStatus;

public: GdPictureStatus SetSignatureValidationMark( 
   bool ShowValidationMark
)

public:
GdPictureStatus SetSignatureValidationMark( 
   bool ShowValidationMark
)

Parameters

ShowValidationMark: Set this parameter to true if you want to display the signature's validity icon along with displaying the signature itself. Otherwise set it to false.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

This method is only allowed for use with non-encrypted documents.

Just to remind you that if you want to apply the defined setting during the signing, you need to set up the required parameter before you start the signing process. But using this method in the whole process is optional.

Prior to Acrobat 6.0, signature appearances were manipulated at run-time in order to display the validity of the signature. The validity was shown as a graphic icon and with an additional, optional text message. Beginning with version 6, Acrobat does not maintain support for signature appearances that can be manipulated, though legacy signatures with these appearances may continue to display correctly. Use of the validity mark in the signature is not recommended.

This method requires the Digital Signatures component to run.

Example

How to set up displaying the signature's validity after the successful signing. You can find the complete sample within the ApplySignature() method's example.

VB.NET
C#

Dim caption As String = "SetSignatureValidationMark"
Dim gdpicturePDF As New GdPicturePDF()
            
'Please load the PDF document you want to sign.
            
'Please set the corresponding certificate - this is a mandatory step.
            
'The icon that represents the validity will display along with the signature. This step is optional.
Dim status As GdPictureStatus = gdpicturePDF.SetSignatureValidationMark(True)
If status <> GdPictureStatus.OK Then
    MessageBox.Show("The method SetSignatureValidationMark() has failed with the status " + status.ToString(), caption)
    GoTo [error]
End If
            
'Please see the complete sample in the ApplySignature() method for next steps to follow.
            
[error]:
gdpicturePDF.Dispose()

string caption = "SetSignatureValidationMark";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
            
//Please load the PDF document you want to sign.
            
//Please set the corresponding certificate - this is a mandatory step.
            
//The icon that represents the validity will display along with the signature. This step is optional.
GdPictureStatus status = gdpicturePDF.SetSignatureValidationMark(true);
if (status != GdPictureStatus.OK)
{
    MessageBox.Show("The method SetSignatureValidationMark() has failed with the status " + status.ToString(), caption);
    goto error;
}
            
//Please see the complete sample in the ApplySignature() method for next steps to follow.
            
error:
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
ApplySignature(String,PdfSignatureMode,Boolean) Method
GetSignatureCount Method
GetSignatureProperties Method