Breadcrumbs

signcap – Settings

All of the following methods set settings that take effect when Capture is called. They must therefore be activated beforehand. The functionality of the interfaces differs in some cases; each method description starts by specifying which interface the method is valid for.

SetPenWidth method

iPadSignotecSignatureDevice

✔️

IPadTabletPC

✔️

Sets the line thickness of the rendered signature for the Image property.
This makes it possible to make the signature thicker or thinner. Alternatively, the value can also be set using SetImageParameter.

C#
void SetPenSize(int nPensize);
C++
HRESULT SetPenSize(int nPensize);

Parameter

In

Out

Possible

Values

Description

nPensize

✔️


1 - 20

Line thickness in pixels


12

Default value

SetImageParameter method

iPadSignotecSignatureDevice

✔️

IPadTabletPC


Sets parameters for rendering the signature image. Can therefore be used to alter the appearance of the signature.

C#
void SetImageParameter(
                       short nResolution,
                       int nWidth,
                       int nHeight,
                       short nPenWidth,
                       uint penColor,
                       int nOptions
                       );
C++
HRESULT SetImageParameter(
                          short nResolution,
                          long nWidth,
                          long nHeight,
                          short nPenWidth,
                          unsigned long penColor,
                          long nOptions
                          );

Parameter

In

Out

Possible

Values

Description

nResolution

✔️


>0

Resolution in pixels per inch (ppi)

nWidth

✔️


>0

Maximum width of the image in pixels

nHeight

✔️


>0

Maximum height of the image in pixels

nPenWidth

✔️


>0

Line thickness in pixels

Setting here is equivalent to setting with SetPenWidth.

penColor

✔️


Six-digit hexadecimal value, each pair of digits determines the strength of the RGB colour components.

Signature colour


0x000000

Black

0xFF0000

Blue

0x00FF00

Green

0x0000FF

Red

0x808080

Gray

nOptions

✔️


Combination of:

Bit mask


0x0001

A visual timestamp is integrated into the image below the signature.

0x0002

The signature is rendered in the image displayed during capture.

The image always has the aspect ratio of the display used; nWidth or nHeight are ignored if necessary.

0x0004

The defined hotspot areas are whitened in the image (only in conjunction with 0x0002).

0x0008

White areas at the sides of the signature are not removed; if nWidth and nHeight are greater than 0, the signature is scaled to the defined height or width depending on the aspect ratio, and the image to be created has exactly the defined size (only if 0x0002 is not set).

0x0010

The signature is aligned to the left (only in conjunction with 0x0008).

0x0020

The signature is aligned to the right (only in conjunction with 0x0008).

0x0040

The signature is aligned to the top (only in conjunction with 0x0008).

0x0080

The signature is aligned to the bottom (only in conjunction with 0x0008).

0x0100

The timestamp size is relative to the height of the created image, not to the height of the display; this setting is useful if the signature is scaled to a given image size to make sure that the timestamp size is independent from the size of the actual signature (only if 0x0001 is set)

0x0200

The signature is never smoothed independent from all other settings. This setting allows very small files to be created.

0x0400

The signature is always smoothed independent from all other settings.

0x0800

The image includes an overlay rectangle if displayed (only in conjunction with 0x0002).

0x1000

White areas are stored as transparent (only if 0x0002 is not set and PNG is selected as the file format).

0x2000

The current display content and not the content displayed during capture is used as the background image (only if 0x0002 is set).

0x4000

The pen width will vary by the value indicated depending on the pressure values.

SetWindowText method

iPadSignotecSignatureDevice

✔️

IPadTabletPC

✔️

Sets the text that is displayed on the model dialog box’s title bar when Capture is called. It can be used to display the name of the signatory, for example.

C#
void SetWindowText(string bstrText);
C++
HRESULT SetWindowText(BSTR bstrText);

Parameter

In

Out

Possible

Values

Description

bstrText

✔️


string

Text for the title bar of the capture dialog


“signotec”

Standard text

SelectDialog method

iPadSignotecSignatureDevice

✔️

IPadTabletPC

✔️

This method adds additional elements to the user dialog during the signature process.

Firstly, a text can be displayed that must be confirmed by the user. On pads, an additional dialog box with the specified text appears before signing. The user can then either confirm the text or cancel the signature process. For tablet PCs, a checkbox with the specified text is added to the dialog box instead, which must be checked before the signature can be confirmed.

In addition, a “Skip” button can be added to the signature dialog. However, this is only available on Sigma and Zeta signature pads.

C#
void SelectDialog (short nIndex, string bstrConfirmationtext);
C++
HRESULT SelectDialog (short nIndex, BSTR bstrConfirmationtext);

Parameter

In

Out

Possible

Values

Description

nIndex

✔️


0

No “Skip” button is displayed.

1

The “Skip” button is displayed.

bstrConfirmationtext

✔️


string,

Length > 0

Displayed text that must be confirmed (only if nIndex = 1)

Empty string

Do not request confirmation

SetButtonPosition method

iPadSignotecSignatureDevice

✔️

IPadTabletPC


Determines the position of the interactive buttons on the pad’s LCD during capture.

C#
void SetButtonPosition(int nButtonPosition);
C++
HRESULT SetButtonPosition(int nButtonPosition);

Parameter

In

Out

Possible

Values

Description

nType

✔️


0

Buttons at the top

1

Buttons at the bottom

2

Buttons on the left

3

Buttons on the right

SetPadType method

iPadSignotecSignatureDevice

✔️

IPadTabletPC


Sets the connection type of the pad to be used.

C#
void SetPadType(short nType);
C++
HRESULT SetPadType(short nType);

Parameter

In

Out

Possible

Values

Description

nType

✔️


101

USB or IP (if SetIPAddress was called)

102

Serial / virtual channel

SetComPort method

iPadSignotecSignatureDevice

✔️

IPadTabletPC


Manually sets the serial interface (COM port) to which the pad is connected. Only effective if the corresponding pad type has been set with SetPadType.

C#
void SetComPort(short nPort);
C++
HRESULT SetComPort(short nPort);

Parameter

In

Out

Possible

Values

Description

nPort

✔️


1–256

COM port to be used

0

All COM ports are searched. This process may take a very long time under certain circumstances.

SetIPAddress method

iPadSignotecSignatureDevice

✔️

IPadTabletPC


Sets the IP address through which the pad is to be addressed. Only effective if the corresponding pad type has been set with SetPadType.

C#
void SetIPAddess(string bstrIPAddress);
C++
HRESULT SetIPAddess(BSTR bstrIPAddress);

Parameter

In

Out

Possible

Values

Description

bstrIPAddress

✔️


string

Valid IP address: Port

Example: “IP=192.168.100.100:1002”

SetLCDText method

iPadSignotecSignatureDevice

✔️

IPadTabletPC


Writes freely definable text lines onto a pad’s LCD. The text lines are output using the “Arial” font. Both the font size and the font style can be modified.

The required text is entered by means of a text field whose top left corner should be specified in pixels. The origin of the coordinate system is the top left corner of the LCD. The height and width of the text field are determined automatically and depend on the amount of text to be displayed and the parameters for this. Text fields may therefore sometimes extend beyond the edge of the pad.

The text is only displayed when the Capture method is called.

C#
HRESULT SetLCDText (
                    int x,
                    int y,
                    string bstrText,
                    int nTextSize,
                    int bBold,
                    int nIndex
                    );
C++
HRESULT SetLCDText (
                    int x,
                    int y,
                    BSTR bstrText,
                    int nTextSize,
                    long bBold,
                    int nIndex
                    );

Parameter

In

Out

Possible

Values

Description

x

✔️


>=0

The X coordinate value for the position at which the text field is to originate.

y

✔️


>=0

The Y coordinate value for the position at which the text field is to originate.

bstrText

✔️


Null-terminated wide character string

Text to be displayed on the LCD

nTextSize

✔️


>=12

Font size

Maximum and minimum values depend on the font selected. If the specified font size is less than 12, font size 12 will be used.

bBold

✔️


0

Normal font

1

Bold type

nIndex

✔️


0

Reserved

SetSampleRate method

iPadSignotecSignatureDevice

✔️

IPadTabletPC


This method sets the sample rate with which the signature is captured. The value is permanently stored in the pad. The default setting is mode 1 (250 Hz). This mode provides high-quality signature data while at the same time ensuring that the data record is of moderate size. For high-speed data lines, this value can also be set to 2 (500 Hz) without any problems. However, the sampling rate currently set in the device can also be adopted.

C#
void SetSampleRate (int nSampleRate);
C++
HRESULT SetSampleRate (long nSampleRate);

Parameter

In

Out

Possible

Values

Description

nSampleRate

✔️


-1

Copy sampling rate from signature pad

0

125 Hz

1

250 Hz (standard)

2

500 Hz