SetSignatureCertificateFromP12(String,String) Method

In This Topic

Sets up the certificate, contained in the digital ID stored in the specified external PKCS#12 file with the filename extension ".p12" or ".pfx". This certificate is later used for the subsequent signing of the currently loaded PDF document. The method works with the file specified by its file path as a string.

Syntax

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

'Declaration
 
Public Overloads Function SetSignatureCertificateFromP12( _
   ByVal CertPath As String, _
   ByVal PFXPassword As String _
) As GdPictureStatus

public GdPictureStatus SetSignatureCertificateFromP12( 
   string CertPath,
   string PFXPassword
)

public function SetSignatureCertificateFromP12( 
    CertPath: String;
    PFXPassword: String
): GdPictureStatus;

public function SetSignatureCertificateFromP12( 
   CertPath : String,
   PFXPassword : String
) : GdPictureStatus;

public: GdPictureStatus SetSignatureCertificateFromP12( 
   string* CertPath,
   string* PFXPassword
)

public:
GdPictureStatus SetSignatureCertificateFromP12( 
   String^ CertPath,
   String^ PFXPassword
)

Parameters

CertPath: The file path to the digital ID file. This file contains the certificate to be used for the subsequent signing.
PFXPassword: The password to open the digital ID file specified above.

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.

This method requires the Digital Signatures component to run.

Example

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

VB.NET
C#

Dim caption As String = "SetSignatureCertificateFromP12"
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.SetSignatureCertificateFromP12("your-digitalID-file.pfx", "your-password")
If status <> GdPictureStatus.OK Then
    MessageBox.Show("The method SetSignatureCertificateFromP12() 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 = "SetSignatureCertificateFromP12";
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.SetSignatureCertificateFromP12("your-digitalID-file.pfx", "your-password");
if (status != GdPictureStatus.OK)
{
    MessageBox.Show("The method SetSignatureCertificateFromP12() 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
Overload List
ApplySignature(String,PdfSignatureMode,Boolean) Method
GetSignatureCount Method
SetSignatureCertificateFromStore Method
SetSignatureCertificateFromSmartCard Method