Dynamic Capture

DynamicCapture

Summary

Method
Capture
GetProperty
SetProperty

Property
Licence

The DynamicCapture object provides the user interface for the capture of a signature.

Methods

Capture

Displays a Signature Capture Window in which a user may sign his or her name using a suitable digitizing tablet. The window contains three buttons by which the user can either clear the currently rendered signature (Clear button) or dismiss the window without capturing a signature (Cancel button) or dismiss the window and capture the currently rendered signature (OK button).

DynamicCaptureResult Capture(SigCtl, Who, Why, What, Key)
Parameters
SigCtl	SigCtl or SigCtlXHTML object.
Who	String specifying the signatory name. Optional if InputWho property of SigCtl is set.
Why	String specifying the reason for signing. Optional if InputWhy property is set.
What	Hash object Derived from the data set with which the captured signature is to be bound. Typically, the data set will be the contents of the document or form signed by the user. SigCtlXHTML: The hash is generated automatically from the contents of the XHTML document and cannot be supplied here. (Optional)
Key	Key object Supplied in order 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
DynamicCaptureResult
Value	Description
DynCaptOK	Signature captured successfully.
DynCaptCancel	Signature not captured because the user canceled the Signature Capture Window.
DynCaptPadError	No capture service available; typically, no functioning digitizing tablet or other device for capturing signatures found.
DynCaptError	System error or some other unusual error condition.
DynCaptAbort	Signature not captured because the handler for the PreCapture event returned False. With SigCtlXHTML, this can indicate a failure to parse document contents.
DynCaptNotLicensed	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
Licence	String	The license object or string.

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"
UILanguage	Get/Set	String	Selects the language used in the signature capture dialog. For details, see SigObj properties
Where	Get/Set	String	Specifies the location of signing. Displayed in the signature capture dialog and saved in the signature data
CaptureInkColor	Get/Set	String	Color of 'ink' used to render the signature image as a comma separated decimal RGB value. e.g. for Blue: setProperty("CaptureInkColor", "0,0,1") Individual color values are in the decimal range 0.0 to 1.0, factoring the RGB maximum of 255 e.g. 0.0 for 0, 0.5 for 127, 1.0 for 255
CaptureInkWidth	Get/Set	String	Decimal width of 'ink' used to render the signature image in mm. Default = 0.7mm, min 0.1mm, max 2.0mm. NB: scales with signature and varies with pressure, when pressure data is available.
CaptureExtentX	Get/Set	DWORD	Sets width of the capture area in pixels. Requires CaptureExtentY to also be set. If not set, the size of the capture area is determined by the size of the digitizer.
CaptureExtentY	Get/Set	DWORD	Sets height of the capture area in pixels. Requires CaptureExtentX to also be set. If not set, the size of the capture area is determined by the size of the digitizer.
ButtonLocation	Get/Set	String	Location of buttons in the capture window: 0 - Outside, 1 - Inside, 2 - Hidden.
LicenceString	Get	String	License name extracted from license string (if set).
stuPort	Get/Set	String	COM port for serial interface e.g., "COM6".
stuBaudRate	Get/Set	DWORD	Serial line speed e.g., 128000.
The following values are for use with the STU-540 device. For details, see: Upload signature screen to STU-540
stuDisableSerialEncryption	Get	DWORD	Images uploaded to the STU will be unencrypted. 0 - inactive, 1 - active.
stuEnableSerialFastClear	Get	DWORD	Reduced delay when the Clear button is pressed. 0 - inactive, 1 - active.
stuSignatureMode	Get/Set	DWORD	Select Signature mode: 0 - default, 1 - signature, 2 - non-signature.
stuSigModeScreenNum	Get/Set	DWORD	Select Signature screen number (1..3).
stuSigModeWhy	Get/Set	String	Why string.
stuSigModeWho	Get/Set	String	Who string.
stuSigModeWhen	Get/Set	String	When string.
stuSigModeOK	Get/Set	String	Text for OK button e.g., dc.SetProperty("stuSigModeOK", "OK (screen 1)").
stuSigModeClear	Get/Set	String	Text for Clear button.
stuSigModeCancel	Get/Set	String	Text for Cancel button.
stuSigModeFontName	Get/Set	String	Font name e.g., "Courier New".
stuSigModeFontSize	Get/Set	DWORD	Font size e.g., 10.
stuSigModeConfig	Set	String	Signature Mode configuration filename e.g., dc.SetProperty("stuSigModeConfig", "c:\config\STU-screens.config,1").