SetSignatureCertificateFromStore Method (GdPicturePDF)

In This Topic

Sets up the certificate, contained in the digital ID stored in the Windows Certificate Store (the current user's store or the local machine's store), specified by its serial number. This certificate is later used for the subsequent signing of the currently loaded PDF document.

Syntax

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

'Declaration
 
Public Function SetSignatureCertificateFromStore( _
   ByVal SerialNumber As String _
) As GdPictureStatus

public GdPictureStatus SetSignatureCertificateFromStore( 
   string SerialNumber
)

public function SetSignatureCertificateFromStore( 
    SerialNumber: String
): GdPictureStatus;

public function SetSignatureCertificateFromStore( 
   SerialNumber : String
) : GdPictureStatus;

public: GdPictureStatus SetSignatureCertificateFromStore( 
   string* SerialNumber
)

public:
GdPictureStatus SetSignatureCertificateFromStore( 
   String^ SerialNumber
)

Parameters

SerialNumber: The serial number of the certificate to be used for the subsequent signing. Use the empty string to allow the application to give you the list of available certificates. Be aware that the serial number string is not case sensitive.

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.

You also need to be aware that setting up the valid certificate is the mandatory step to be able to digitally sign the PDF document. Please select the appropriate method for carrying out this requirement according to your preference before you start the signing process.

Just to remind you that you can use the empty string if you are not sure about the correct serial number of your certificate. The application pops up a window to allow you to select a correct one from the current user's store or the local machine's store.

This method requires the Digital Signatures component to run.

Example

How to set up the certificate (digital ID) from the Windows Certificate Store for the subsequent signing. You can find the complete sample within the ApplySignature() method's example.

VB.NET
C#

Dim caption As String = "SetSignatureCertificateFromStore"
Dim gdpicturePDF As New GdPicturePDF()
            
'Please load the PDF document you want to sign.
            
'This is the first step in the signing process. It is the mandatory step. Select the method according to your preference.
Dim status As GdPictureStatus = gdpicturePDF.SetSignatureCertificateFromStore("serial-number-of-your-certificate")
            
'Or you can use the empty string instead to allow the application to give you a list of certificates in the current user's store.
'GdPictureStatus status = gdpicturePDF.SetSignatureCertificateFromStore("");
            
If status <> GdPictureStatus.OK Then
    MessageBox.Show("The method SetSignatureCertificateFromStore() 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 = "SetSignatureCertificateFromStore";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
            
//Please load the PDF document you want to sign.
            
//This is the first step in the signing process. It is the mandatory step. Select the method according to your preference.
GdPictureStatus status = gdpicturePDF.SetSignatureCertificateFromStore("serial-number-of-your-certificate");
            
//Or you can use the empty string instead to allow the application to give you a list of certificates in the current user's store.
//GdPictureStatus status = gdpicturePDF.SetSignatureCertificateFromStore("");
            
if (status != GdPictureStatus.OK)
{
    MessageBox.Show("The method SetSignatureCertificateFromStore() 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
SetSignatureCertificateFromP12(String,String) Method
SetSignatureCertificateFromSmartCard Method