(Excel) PDF Signature Appearance Text Substitution Keywords

See more PDF Signatures Examples

This example demonstrates the text substitution keywords that can be used in the PDF signature's appearance text.

Note: This example requires Chilkat v9.5.0.85 or greater.

Download Excel Class Modules Chilkat Excel Class Modules

' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim pdf As Chilkat.Pdf
Set pdf = Chilkat.NewPdf

' Load a PDF to be signed.

success = pdf.LoadFile("qa_data/pdf/empty.pdf")
If (success = False) Then
    Debug.Print pdf.LastErrorText
    Exit Sub
End If

' Options for signing are specified in JSON.
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject

' In most cases, the signingCertificateV2 and signingTime attributes are required.
Dim success As Boolean
success = json.UpdateInt("signingCertificateV2",1)
success = json.UpdateInt("signingTime",1)

' Put the signature on page 1, top left
success = json.UpdateInt("page",1)
success = json.UpdateString("appearance.y","top")
success = json.UpdateString("appearance.x","left")

' Use a font scale of 7.0
success = json.UpdateString("appearance.fontScale","7.0")

' The appearance of the PDF signature can contain any number of text lines.
' Chilkat has defined a number of special keywords that can be used in any text line.
' Each keyword is replaced with the actual value.
' For example, "cert_cn" is replaced with the certificate subject's common name (CN).

' Here we are creating a signature with many lines of text, to demonstrate each
' keyword.
success = json.UpdateString("appearance.text[0]","Date/time in PDF format: current_dt")
success = json.UpdateString("appearance.text[1]","Current Local date/time: current_datetime")
success = json.UpdateString("appearance.text[2]","GMT Timestamp: current_timestamp_gmt")
success = json.UpdateString("appearance.text[3]","Local Timestamp: current_timestamp_local")
success = json.UpdateString("appearance.text[4]","GMT RFC822 date/time: current_rfc822_dt_gmt")
success = json.UpdateString("appearance.text[5]","Local RFC822 date/time: current_rfc822_dt_local")
success = json.UpdateString("appearance.text[6]","Cert DN (Distinguished Name): cert_dn")
success = json.UpdateString("appearance.text[7]","Cert Common Name: cert_cn")
success = json.UpdateString("appearance.text[8]","Cert Organizational ID (2.5.4.97): cert_org_id")
success = json.UpdateString("appearance.text[9]","Cert Email: cert_email")
success = json.UpdateString("appearance.text[10]","Cert Organization: cert_organization")
success = json.UpdateString("appearance.text[11]","Cert Organziational Unit: cert_ou")
success = json.UpdateString("appearance.text[12]","Cert State: cert_state")
success = json.UpdateString("appearance.text[13]","Cert Country: cert_country")
success = json.UpdateString("appearance.text[14]","Cert Locality: cert_locality")
success = json.UpdateString("appearance.text[15]","Cert Serial Number (hex): cert_serial_hex")
success = json.UpdateString("appearance.text[16]","Cert Serial Number (decimal): cert_serial_dec")
success = json.UpdateString("appearance.text[17]","Cert Thumbprint: cert_thumbprint")
success = json.UpdateString("appearance.text[18]","Cert Issuer Common Name: cert_issuer_cn")

Dim jpgData As Chilkat.BinData
Set jpgData = Chilkat.NewBinData
success = jpgData.LoadFile("qa_data/jpg/seal1.jpg")
If (success = False) Then
    Debug.Print "Failed to load the JPG image."
    Exit Sub
End If

success = pdf.SetSignatureJpeg(jpgData)
If (success = False) Then
    Debug.Print pdf.LastErrorText
    Exit Sub
End If

' Specify that we want to display the JPG image in the center with 33% opacity.
success = json.UpdateString("appearance.image","custom-jpg")
success = json.UpdateString("appearance.imagePlacement","center")
success = json.UpdateString("appearance.imageOpacity","33")

' Load the signing certificate. (Use your own certificate.)
Dim cert As Chilkat.Cert
Set cert = Chilkat.NewCert
success = cert.LoadPfxFile("qa_data/pfx/myPdfSigningCert.pfx","pfx_password")
If (success = False) Then
    Debug.Print cert.LastErrorText
    Exit Sub
End If

' Tell the pdf object to use the certificate for signing.
success = pdf.SetSigningCert(cert)
If (success = False) Then
    Debug.Print pdf.LastErrorText
    Exit Sub
End If

success = pdf.SignPdf(json,"qa_output/hello_signed.pdf")
If (success = False) Then
    Debug.Print pdf.LastErrorText
    Exit Sub
End If

Debug.Print "The PDF has been successfully cryptographically signed."

' The appearance of the signature appears in Adobe Acrobat as shown here: