eSeal

eSeal

Summary

Method
Capture
GetProperty
SetProperty

Property
CacheImage
HAlign
Height
HScale
Id
Licence
Name
Transparency
URL
VAlign
VScale
Width

NB: The eSeal object provides the user interface for the insertion of an eSeal image into a signature area with the optional capture of a handwritten signature.

Methods

Capture

Optionally displays a Signature Capture Window (see DynamicCapture) and inserts an eSeal image in the signature area. If the eSeal has not already been cached, the URL is accessed to download the referenced file.

Capture
Captures a signature using the provided SigCtl object and eSeal capture mode.
Parameters
SigCtl	SigCtl or SigCtlXHTML object
Mode	eSealCaptureMode: esRequireSignature - Insert eSeal and capture handwritten signature esNoSignature - Insert eSeal (without signature capture) esSignatureOptional - Insert eSeal and capture signature if tablet is available
Who	String specifying the signatory name. Optional if InputWho property of SigCtl is set.
Why	String specifying the reason for signing. Optional if InputWho property of SigCtl is set.
What	Hash object derived from the data set with which the captured signature is to be bound. SigCtlXHTML: The hash is generated automatically from the XHTML document contents and cannot be supplied here. (Optional)
Key	Key object supplied to detect malicious or accidental tampering with the signature object or the signature data it contains. SigCtlXHTML: Key type SHA-256 is used automatically but an alternative can be specified. (Optional)
Return Value
eSealCaptureResult
esCaptureOK	Signature captured successfully.
esCaptureCancel	Signature not captured because user cancelled Signature Capture Window.
esCapturePadError	No capture service available; typically, no functioning digitizing tablet or other device for capturing signatures found.
esCaptureError	System error or some other unusual error condition.
esCaptureAbort	Signature not captured because the handler for the PreCapture event returned False. With SigCtlXHTML, this can indicate a failure to parse document contents.
esCaptureNoImage	Unable to load eSeal image from URL, or parameter error.
esCaptureNotLicensed	The component has not been licensed to perform capture. This may be because a suitable license has not been set or because a condition of the license has not been met, for example, required hardware, such as a particular tablet type, was not found.

GetProperty

Returns the current value of a property.

GetProperty
Parameters
Name	The name of the property to retrieve.
Return Value
Variant
- Variant: Current value of the named property.
- Empty: If no value has been set.

SetProperty

Sets the value of a named additional property, overrides a value set in the registry.

SetProperty
Parameters
Name	String. Name of the property.
Value	Value to assign to the property.
Return Value
Boolean
- True: Name exists and value is valid.
- False: Failed to set property.

Properties

Property	Type	Description
CacheImage	boolean	False if URL is to be accessed at time of signing.
HAlign	eSealHAlign (enum)	Horizontal alignment of image within the signature area (defaults to 1=centre).
Height	Int	Height of image in HIMETRIC (0.01mm) units (Read-only).
HScale	Int	Percentage scaling of image X dimension (defaults to 100).
id	String	GUID for internal use only (Read-only).
Licence	Variant	Licence object or string.
Name	String	Name for internal use only (Read-only).
Transparency	Int	Percentage transparency, 0 = unchanged, 100 = not visible (defaults to 0 = unchanged).
URL	String	URL of image file. Maximum size is 32K. Use compressed format or reduce bit depth if necessary.
VAlign	eSealVAlign (enum)	Vertical alignment of image within the signature area (defaults to 1=centre).
VScale	Int	Percentage scaling of image Y dimension (defaults to 100).
Width	Int	Width of image in HIMETRIC (0.01mm) units (Read-only).

Properties supported by GetProperty/SetProperty

Name	Get/Set	Type	Description
Licence	Get/Set	String	String containing the license used for signature capture.
Component_FileVersion	Get	String	Component version e.g. "4.5.2.210".
Where	Get/Set	String	Specifies the location of signing. The string is displayed in the signature capture dialog and saved in the signature data.