Control iSign

This control provides the functionality of CIC's ink capture and display technology for web developers.

To embed the control into your html page either use a tool like Microsoft Visual Studio.Net 2003 or similar, or add the following code to your source file. Using a tool will also make it a lot easier to set initial properties like borderstyle, bordercolor, inkcolor, etc. since you can use the built-in property sheets.

<OBJECT style="Z-INDEX: 115; LEFT: 40px; WIDTH: 400px; POSITION: absolute; TOP: 136px; HEIGHT: 224px"
name="iSign1" id="iSign1" codeBase="../Cab/iSignNet.cab#version=4,0,0,5323"
classid="clsid:93E5204A-4344-4381-8912-8A7091E0FAE5" VIEWASTEXT>
<PARAM NAME="_cx" VALUE="10583">
<PARAM NAME="_cy" VALUE="5927">
<PARAM NAME="BackgroundColor" VALUE="16777215">
<PARAM NAME="InkColor" VALUE="0">
<PARAM NAME="BorderStyle" VALUE="3">
<PARAM NAME="BorderColor" VALUE="0">
<PARAM NAME="InkWidth" VALUE="2">
<PARAM NAME="WritingGuide" VALUE="2">
<PARAM NAME="Timeout" VALUE="750">
<PARAM NAME="EncryptionEnabled" VALUE="0">
<PARAM NAME="Enabled" VALUE="1">
<PARAM NAME="EncryptionAlgorithm" VALUE="1">
<PARAM NAME="EncryptionKey" VALUE="">
</OBJECT>

 
Property Summary
int

BackgroundColor

Background color of the control window.

int

BorderStyle

Border style of the control window.

int

BorderColor

Border color of the control window.

int

CtlEnabled

Enables/disables inking in control.

_EncrAlg

EncryptionAlgorithm

Sets the encryption algorithm

int

EncryptionEnabled

Enables/disables the encryption of the ink.

string

EncryptionKey

Sets the encryption key

long

HashVal

Return the result(s) of the hashing done using InitHash, AddHash and FinishHash.  Each hash value is a long integer. 

bool

Initialized

READ-ONLY. TRUE if control is fully initialized.

int

InkColor

Current color of ink input.

int

InkWidth

Current width of ink input.

int

SamplingRate

READ-ONLY. The current sampling rate for the signature. This is needed for verifying the signature.

string

Signature

The signature data. Access this property to save or restore the control's contents from disk or a database.

_SignatureStatus

Status

The status of the signature stream-in process.

int

TimeOut

The timeout for the InkReady event in milliseconds.

int

WritingGuide

Option of letter guide, signature guide or no guide.

 

Method Summary
long

AddHash(string sHash)

Adds string to be hashed to the current hashing session.

void

ClearSignature( )

Clears the signature in the control.

long

FinishHash( )

Finalizes the hashing session and returns the result in HashVal1 through HashVal5 or HashVal.

void

InitHash( )

Initiates a hashing session. Is used in conjunction with AddHash and FinishHash.

long

HasInk( )

Returns whether or not control contains any ink .

void

SetHashAlgorithm (int alg)

Set the hash mode.

 

Event Summary
 

OnInkReady

Occurs 750 milliseconds after the last pen-down point. The timeout can be changed using the Timeout property.

 

OnStrokeReady

Occurs immediately when the pen is lifted at the end of a stroke.

 

 

Property Details

BackgroundColor

public static int BackgroundColor

Background color of the control window.


BorderStyle

public static int BorderStyle

Border style of the control window.

Options:

0
None
1
Single
2
Double
3
3D

VB.Net Usage: Object.BorderStyle = 3

C# Usage: Object.BorderStyle = (ISIGNCONTROLLib._BorderStyle) 3; // 3D


BorderColor

public static int BorderColor

Border color of the control window.


CtlEnabled

public static int CtlEnabled

Enables/disables inking in control.

Options:

0
Disabled
1
Enabled

VB.Net Usage: object.CtlEnabled = 1

C# Usage: object.CtlEnabled = 1;


EncryptionAlgorithm

public static ISIGNCONTROLLib._EncrAlg EncryptionAlgorithm

Sets the encryption algorithm

Op tions:

-1
NONE
No encryption algorithm specified.
0
FAST CIC's FAST encryption algorithm
1
DES DES 56 bit encryption algorithm
2
DES_40 DES 40 bit encryption algorithm
3
TRIPLE_DES DES 128 bit encryption algorithm

VB.Net Usage: object.EncryptionAlgorithm = 3  ' Triple_DES used here

C# Usage: object.EncryptionAlgorithm = (ISIGNCONTROLLib._EncrAlg)  3;  // Triple_DES used here


EncryptionEnabled

public static int EncryptionEnabled

Enables/disables the encryption of the ink.

Options:

0
Disabled
1
Enabled

VB.Net Usage: object.EncryptionEnabled = 1

C# Usage: object.EncryptionEnabled = 1;


EncryptionKey

public static string Encryptionkey

Sets the encryption key

VB.Net Usage: object.Encryptionkey = "12345678"

C# Usage: object.Encryptionkey = "12345678";


HashVal

public static string HashVal

Return the result(s) of the hashing done using InitHash, AddHash and FinishHash.  Each hash value is a long integer. 

VB.Net Usage: Dim s As String = object.HashVal

C# Usage: object.HashVal;


Initialized

public static bool Initialized

READ-ONLY. TRUE if control is fully initialized.

VB.Net Usage: object.Initialized

C# Usage: object.Initialized;


InkColor

public static int InkColor

Sets/gets the current color of ink input.

VB.Net Usage: object.InkColor = Color.Blue

C# Usage: object.InkColor;


InkWidth

public static int InkWidth

Sets/gets the current width of ink input.

VB.Net Usage: object.InkWidth = 5

C# Usage: object.InkWidth = 5;


SamplingRate

public static int SamplingRate

READ-ONLY. The current sampling rate for the signature. This is needed for verifying the signature.

VB.Net Usage: Dim i As Integer = object.SamplingRate

C# Usage: object.SamplingRate;


Signature

public static string Signature

The signature data. Access this property to save or restore the control's contents from disk or a database.

VB.Net Usage: Dim s As String = object.signature

C# Usage: object.signature;


Status

public static ISIGNCONTROLLib._SignatureStatus Status

The status of the signature stream-in process.

Returns:

0
SigOK
The signature stream in process is OK
-1
SigError The signature stream process has an error

VB.Net Usage: if object.Status = ISIGNCONTROLLib._SignatureStatus.sigOK

C# Usage: if (object.Status == ISIGNCONTROLLib._SignatureStatus.sigOK)


TimeOut

public static int TimeOut

The timeout for the InkReady event in milliseconds.

VB.Net Usage: object.TimeOut = 750

C# Usage: object.TimeOut = 750;


WritingGuide

public static int WritingGuide

Option of letter guide, signature guide or no guide.

Options:

0
wgNONE No writing guide
1 wgUnderline Specify the underline guide
2 wgSignatureLine Specify the signature line guide

VB.Net Usage: object.WritingGuide = 2

C# Usage: object.WritingGuide = 2;

 

Method Details

AddHash(string sHash)

public long AddHash(string sHash)

Adds string to be hashed to the current hashing session.

Returns:

0
Success
100 MaxLengthExceeded
101 Bad Mode

VB.Net Usage: Dim r As Long = object.AddHash(signature)

C# Usage: object.AddHash(signature);


ClearSignature()

public void ClearSignature()

Clears the signature in the control.

VB.Net Usage: object.ClearSignature

C# Usage: object.ClearSignature( );


FinishHash()

public long FinishHash()

Finalizes the hashing session and returns the result in HashVal1 through HashVal5.

Returns: Always returns Success = 0

VB.Net Usage: Dim r As Long = object.FinishHash

C# Usage: object.FinishHash( );


HasInk( )

public long HasInk( )

Returns whether or not control contains any ink.

Returns:

0
no ink
1 ink exists

VB.Net Usage: Dim r As Long = object.HasInk

C# Usage: object.HasInk( );


InitHash()

public void InitHash()

Initiates a hashing session. Is used in conjunction with AddHash and FinishHash.

VB.Net Usage: object.InitHash

C# Usage: object.InitHash( );


SetHashAlgorithm (int alg)

public void SetHashAlgorithm (int alg)

Set the hash mode.

Mode :

0
HASH_SHA0
SHAO Algorithm
1
HASH_SHA1
SHA1 Algorithm

Default is SHA0. Once set, all hash operation are done in this mode until control is unloaded.

VB.Net Usage: object.SetHashAlgorithm (1)

C# Usage: object.SetHashAlgorithm (1)

 

Event Details

OnInkReady

Occurs 750 milliseconds after the last pen-down point. The timeout can be changed using the Timeout property.

VB.Net Usage: object_OnInkReady(object sender, System.EventArgs e)

C# Usage: object_OnInkReady(object sender, System.EventArgs e);


OnStrokeReady

Occurs immediately when the pen is lifted at the end of a stroke.

VB.Net Usage: object_OnStrokeReady(object sender, System.EventArgs e)

C# Usage: object_OnStrokeReady(object sender, System.EventArgs e);