(SQL Server) PDF Signature Appearance Width and Height

See more PDF Signatures Examples

This example explains how the width and height of the signature appearance rectangle box is determined.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @pdf int
    -- Use "Chilkat_9_5_0.Pdf" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Pdf', @pdf OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Load a PDF to be signed.
    -- The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
    DECLARE @success int
    EXEC sp_OAMethod @pdf, 'LoadFile', @success OUT, 'qa_data/pdf/hello.pdf'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pdf, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        RETURN
      END

    -- Options for signing are specified in JSON.
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    -- In most cases, the signingCertificateV2 and signingTime attributes are required.
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'signingCertificateV2', 1
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'signingTime', 1

    -- Put the signature on page 1, top left
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'page', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.y', 'top'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.x', 'left'

    -- Add some text.
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.text[0]', 'Digitally signed by: cert_cn'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.text[1]', 'current_dt'

    -- Add a built-in SVG graphic to the right.
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.image', 'blue-check-mark'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.imagePlacement', 'right'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.imageOpacity', '100'

    -- There are 4 ways the width and height of the signature rectangle can be specified.
    -- 1) The width and height (in points) are both explicitly specified.
    --    User space coordinates use "points" where 72 points equals 1 inch.
    --    For example (3 inches wide and 1 inch high)
    --    The fontScale is automatically chose to fit.  In addition, if a graphic (JPG or built-in SVG) is included,
    --    it is automatically scaled such that the text + graphic fit together in the specified rectangle.
    --    Note: When both height and width are explicitly specified, the resultant signature appearance rectangle
    --    will match one of the dimensions, but the other dimension will be equal or smaller.  This is because the text
    --    must be proportionally scaled.
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'appearance.width', 72 * 3
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'appearance.height', 72

    -- The signature would have this appearance. In this case, the height is actually less than 1 inch because
    -- if Chilkat chose a fontScale to fill the height, the resulting text's width would be too long for the desired width. 
    

    -- 2) The width is explicitly specified, but we use the keyword "auto" for height.
    --    In this case, the fontScale is chosen to achieve the desired width,
    --    and the height will be whatever the result of the chosen font scale.
    --    In this example, the width is 4 inches, and the height is "auto".
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'appearance.width', 72 * 4
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.height', 'auto'

    -- The signature would have this appearance: 
    

    -- 3) The height is explicitly specified, but we use the keyword "auto" for width.
    --    In this case, the fontScale is chosen to achieve the desired height,
    --    and the width will be whatever the result of the chosen font scale.
    --    In this example, the height is 1 inch (72 points) and the width is "auto".
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.width', 'auto'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'appearance.height', 72

    -- The signature would have this appearance.
    

    -- 4) Finally, we don't need to specify width/height at all.  Instead, we can choose a fontScale
    --    and the dimensions of the PDF signature appearance's rectangle will be the result of using the
    --    specified fontScale.

    DECLARE @jAppearance int
    EXEC sp_OAMethod @json, 'ObjectOf', @jAppearance OUT, 'appearance'
    EXEC sp_OAMethod @jAppearance, 'Delete', @success OUT, 'width'
    EXEC sp_OAMethod @jAppearance, 'Delete', @success OUT, 'height'
    EXEC @hr = sp_OADestroy @jAppearance

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.fontScale', '10.0'

    -- With fontScale = "10.0"
    

    -- Load the signing certificate. (Use your own certificate.)
    DECLARE @cert int
    -- Use "Chilkat_9_5_0.Cert" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Cert', @cert OUT

    EXEC sp_OAMethod @cert, 'LoadPfxFile', @success OUT, 'qa_data/pfx/myPdfSigningCert.pfx', 'pfx_password'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @cert, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    -- Tell the pdf object to use the certificate for signing.
    EXEC sp_OAMethod @pdf, 'SetSigningCert', @success OUT, @cert
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pdf, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    EXEC sp_OAMethod @pdf, 'SignPdf', @success OUT, @json, 'qa_output/hello_signed.pdf'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pdf, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END


    PRINT 'The PDF has been successfully cryptographically signed.'

    EXEC @hr = sp_OADestroy @pdf
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @cert


END
GO