DataFlex

PDF Signature Page Location

See more PDF Signatures Examples

This example demonstrates how to specify the location of a PDF signature on a page.

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

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoPdf
    Variant vJson
    Handle hoJson
    Variant vCert
    Handle hoCert
    Handle hoPdf2
    String sTemp1
    Integer iTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatPdf)) To hoPdf
    If (Not(IsComObjectCreated(hoPdf))) Begin
        Send CreateComObject of hoPdf
    End

    // Load a PDF to be signed.
    // The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
    Get ComLoadFile Of hoPdf "qa_data/pdf/hello.pdf" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPdf To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Options for signing are specified in JSON.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End

    // In most cases, the signingCertificateV2 and signingTime attributes are required.
    Get ComUpdateInt Of hoJson "signingCertificateV2" 1 To iSuccess
    Get ComUpdateInt Of hoJson "signingTime" 1 To iSuccess

    // When cryptographically signing a PDF, the signature's appearance can be placed on a specific
    // page in the PDF document, and at a specified location on the page.
    // The 1st page of the PDF document is page number 1 (we don't use 0-based numbering for PDF page numbers).
    // The PDF object has a NumPages property, so we can use it to sign on the last page of the PDF.
    Get ComNumPages Of hoPdf To iTemp1
    Get ComUpdateInt Of hoJson "page" iTemp1 To iSuccess

    // appearance.y and appearance.x JSON properties control the x,y location of the signature.
    // The "appearance.y" can be "top" or "bottom".
    // The "appearance.x" can be "left", "middle", or "right".
    // It is also possible to specify exact PDF location in user space coordinates, which is discussed below.
    Get ComUpdateString Of hoJson "appearance.y" "bottom" To iSuccess
    Get ComUpdateString Of hoJson "appearance.x" "middle" To iSuccess

    // In this example, the fontScale (in combination with the number of appearance text lines and the length of the longest text line),
    // automatically determine the width/height of the signature text box. Any included graphic (JPG image or built-in SVG) is automatically
    // scaled to fit. It is alternatively possible to specify the desired width/height of the signature rectangle.  In that case
    // you would NOT specify a fontScale because Chilkat would automatically chose a font scale to fit the text to the desired rectangle.
    // This example demonstrates how to specify the exact width/height of the PDF signature text box.
    Get ComUpdateString Of hoJson "appearance.fontScale" "9.0" To iSuccess

    Get ComUpdateString Of hoJson "appearance.text[0]" "Digitally signed by: cert_cn" To iSuccess
    Get ComUpdateString Of hoJson "appearance.text[1]" "current_dt" To iSuccess
    Get ComUpdateString Of hoJson "appearance.image" "document-accepted" To iSuccess
    Get ComUpdateString Of hoJson "appearance.imagePlacement" "left" To iSuccess
    Get ComUpdateString Of hoJson "appearance.imageOpacity" "100" To iSuccess

    // Load the signing certificate. (Use your own certificate.)
    Get Create (RefClass(cComChilkatCert)) To hoCert
    If (Not(IsComObjectCreated(hoCert))) Begin
        Send CreateComObject of hoCert
    End
    Get ComLoadPfxFile Of hoCert "qa_data/pfx/myPdfSigningCert.pfx" "pfx_password" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoCert To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Tell the pdf object to use the certificate for signing.
    Get pvComObject of hoCert to vCert
    Get ComSetSigningCert Of hoPdf vCert To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPdf To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get pvComObject of hoJson to vJson
    Get ComSignPdf Of hoPdf vJson "qa_output/hello_signed.pdf" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPdf To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "The PDF has been successfully cryptographically signed."

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

    // ----------------------------------------------------------------------------------------------------
    // *** Scroll down for information about specifying the PDF signature x,y location in user space coordinates.
    // ----------------------------------------------------------------------------------------------------

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

    // The x,y coordinates of a PDF page are in "user space", called "points", and there are 72 pointes per inch.
    // A PDF page (8.5" x 11") is 612 points wide and 792 points high.
    // The bottom left is at 0,0.    The top right is at 612,792.
    // 
    // To specify the location of a signature rectangle, the "appearance.y" is the y coordinate of the top of the signature rectangle,
    // and the "appearance.x" is the x coordinate of the left of the signature rectangle.
    // Therefore, to position the signature rectangle at the exact top/left of the page, we do this:

    Get ComUpdateString Of hoJson "appearance.y" "792" To iSuccess
    Get ComUpdateString Of hoJson "appearance.x" "0" To iSuccess

    Get ComUpdateString Of hoJson "appearance.text[0]" "Digitally signed again by: cert_cn" To iSuccess
    Get ComUpdateString Of hoJson "appearance.text[1]" "current_dt" To iSuccess
    Get ComUpdateString Of hoJson "appearance.image" "document-accepted" To iSuccess
    Get ComUpdateString Of hoJson "appearance.imagePlacement" "right" To iSuccess

    Get Create (RefClass(cComChilkatPdf)) To hoPdf2
    If (Not(IsComObjectCreated(hoPdf2))) Begin
        Send CreateComObject of hoPdf2
    End
    Get ComLoadFile Of hoPdf2 "qa_output/hello_signed.pdf" To iSuccess
    Get pvComObject of hoCert to vCert
    Get ComSetSigningCert Of hoPdf2 vCert To iSuccess

    Get pvComObject of hoJson to vJson
    Get ComSignPdf Of hoPdf2 vJson "qa_output/hello_signed2.pdf" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPdf2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "The PDF has been successfully cryptographically signed again."

    // Here we have the PDF with the signature just added at the exact top/left.
    // (image:https://example-code.com/images/pdf_signature_top_left.jpg/endImage)


End_Procedure