PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Pdf
oleobject loo_Json
oleobject loo_JpgData
oleobject loo_Cert

li_Success = 0

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

loo_Pdf = create oleobject
li_rc = loo_Pdf.ConnectToNewObject("Chilkat.Pdf")
if li_rc < 0 then
    destroy loo_Pdf
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Load a PDF to be signed.
li_Success = loo_Pdf.LoadFile("qa_data/pdf/empty.pdf")
if li_Success = 0 then
    Write-Debug loo_Pdf.LastErrorText
    destroy loo_Pdf
    return
end if

// Options for signing are specified in JSON.
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

// In most cases, the signingCertificateV2 and signingTime attributes are required.
loo_Json.UpdateInt("signingCertificateV2",1)
loo_Json.UpdateInt("signingTime",1)

// Put the signature on page 1, top left
loo_Json.UpdateInt("page",1)
loo_Json.UpdateString("appearance.y","top")
loo_Json.UpdateString("appearance.x","left")

// Use a font scale of 7.0
loo_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.
loo_Json.UpdateString("appearance.text[0]","Date/time in PDF format: current_dt")
loo_Json.UpdateString("appearance.text[1]","Current Local date/time: current_datetime")
loo_Json.UpdateString("appearance.text[2]","GMT Timestamp: current_timestamp_gmt")
loo_Json.UpdateString("appearance.text[3]","Local Timestamp: current_timestamp_local")
loo_Json.UpdateString("appearance.text[4]","GMT RFC822 date/time: current_rfc822_dt_gmt")
loo_Json.UpdateString("appearance.text[5]","Local RFC822 date/time: current_rfc822_dt_local")
loo_Json.UpdateString("appearance.text[6]","Cert DN (Distinguished Name): cert_dn")
loo_Json.UpdateString("appearance.text[7]","Cert Common Name: cert_cn")
loo_Json.UpdateString("appearance.text[8]","Cert Organizational ID (2.5.4.97): cert_org_id")
loo_Json.UpdateString("appearance.text[9]","Cert Email: cert_email")
loo_Json.UpdateString("appearance.text[10]","Cert Organization: cert_organization")
loo_Json.UpdateString("appearance.text[11]","Cert Organziational Unit: cert_ou")
loo_Json.UpdateString("appearance.text[12]","Cert State: cert_state")
loo_Json.UpdateString("appearance.text[13]","Cert Country: cert_country")
loo_Json.UpdateString("appearance.text[14]","Cert Locality: cert_locality")
loo_Json.UpdateString("appearance.text[15]","Cert Serial Number (hex): cert_serial_hex")
loo_Json.UpdateString("appearance.text[16]","Cert Serial Number (decimal): cert_serial_dec")
loo_Json.UpdateString("appearance.text[17]","Cert Thumbprint: cert_thumbprint")
loo_Json.UpdateString("appearance.text[18]","Cert Issuer Common Name: cert_issuer_cn")

loo_JpgData = create oleobject
li_rc = loo_JpgData.ConnectToNewObject("Chilkat.BinData")

li_Success = loo_JpgData.LoadFile("qa_data/jpg/seal1.jpg")
if li_Success = 0 then
    Write-Debug "Failed to load the JPG image."
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_JpgData
    return
end if

li_Success = loo_Pdf.SetSignatureJpeg(loo_JpgData)
if li_Success = 0 then
    Write-Debug loo_Pdf.LastErrorText
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_JpgData
    return
end if

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

// Load the signing certificate. (Use your own certificate.)
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")

li_Success = loo_Cert.LoadPfxFile("qa_data/pfx/myPdfSigningCert.pfx","pfx_password")
if li_Success = 0 then
    Write-Debug loo_Cert.LastErrorText
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_JpgData
    destroy loo_Cert
    return
end if

// Tell the pdf object to use the certificate for signing.
li_Success = loo_Pdf.SetSigningCert(loo_Cert)
if li_Success = 0 then
    Write-Debug loo_Pdf.LastErrorText
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_JpgData
    destroy loo_Cert
    return
end if

li_Success = loo_Pdf.SignPdf(loo_Json,"qa_output/hello_signed.pdf")
if li_Success = 0 then
    Write-Debug loo_Pdf.LastErrorText
    destroy loo_Pdf
    destroy loo_Json
    destroy loo_JpgData
    destroy loo_Cert
    return
end if

Write-Debug "The PDF has been successfully cryptographically signed."

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

// (image:https://example-code.com/images/pdf_signature_text_replacements.jpg/endImage)


destroy loo_Pdf
destroy loo_Json
destroy loo_JpgData
destroy loo_Cert