Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...


If you have a signature pad with colour display, you can use the DocumentViewing mode to show the document on the signature device. There are 2 functions to use the DocumentViewing mode (ViewDocOnDevice and ViewDocOnDeviceDefaultZoom) and the only difference between them, is just the option to set a starting page. The DocumentViewing mode also supports a button to start the SigningMode, which allows the user to trigger the signing procedure directly from the signature pad (Event OnLCDSignButton).


Signing the document

The placement specification of a signature needs to be done with PDF coordinates. You need the top/left as well as the botton/right corner and also the page number. It´s possible to convert centimeters/inches to PDF points: usually a PDF file has 72 points per inch, which means the size of a normal PDF page is normally 595x842 and the top/left corner has the value 0x0. You need the PDF coordinates for the different AddSignature functions and if want to use the SignInDocument Mode also for the SetSignDocMode function (the values should be the same, otherwise the signature will not be at the same position, which the signer saw while signing on the pad).

...

For adding a Signature you need to activate the Signature Mode of the device with the DeviceAPI function startCapture, when the signier is finished the signature can be added to the document. For that you need to call the AddSignature or AddSignatureField ( in case you want to store the signature into an exsiting Signature Field). In case the Return value is not 1, you need to check if you added all the Callback Events and if the placement informations are correct. The function AddSignatureImage allows you to insert an image into the PDF document, this image can be Stamp or you can use this function to add additional informations into the document. The image is added as a Signature, which means you can use this functionallty also with an already signed document without making the exsiting signature invalid.


 

Function NameInformation
SearchKeyStringFunction, which returns all coordinate sets for a searched string in the document.
GetSigFieldsFunction, which returns the coordinates of all signature fields (signed and unsigned). The unsigned field coordinates can be used for SetSignDocMode.
SetSignDocMode Function to set the signing postion in the document for the SignInDocument Mode (needs to be called before startCapture).
SetLcdSignZoomFunction to change the zoom level of the SignInDocument Mode (needs to be called before SetSignDocMode).
SetSignatureFrameParamsFunction to change the configuration of the signature rectangle for the SignInDocument Mode (needs to be called before SetSignDocMode).
AddSignatureFunction to add a signature to the PDF document. This function will insert a new SignatureField into the document.
AddSignatureFieldFunction to add a signature to an empty signature field (In which case the placement with coordinates is not nessecary).
AddSignatureImageFunction to add an image as signature to the document.
TimeCenterURLProperty to define a TimeStampServer to get time stamp for the signature (by default the local system time is used).
DeviceModelProperty to set the Device Name (visible in the DigitalSignature).
DeviceSerialProperty to set the Device Serial (visible in the DigitalSignature).


Saving and closing a document

After the last signature, the signature pad can be set back to the StandBy Mode by using the DeviceAPI function /wiki/spaces/SDDP/pages/79398591 and the document can be saved.

The SignAPI has two function to save the document: SaveDoc will save the loaded document to its original path and filename, while SaveDocTo saves the signed document to another path and with a new filename.

The last step is to close the document with CloseDoc, which will release the document from the SignAPI and will erase temporary file.

Function NameInformation
SaveDocFunction to save the document to it's original location.
SaveDocToFunction to save the document to a different location.
CloseDocFunction to unload the document from the SignAPI.

...