SetSignatureFrameParams

Declaration

Delphi

procedure TStepOverSignatureAPIv4.SetSignatureFrameParams(DrawFame: WordBool; FrameColor: OLE_COLOR; FrameThickness: Integer; FillBody: WordBool; BodyColor: OLE_COLOR; BodyOpacity: Integer);

ActiveX

HRESULT _stdcall SetSignatureFrameParams([in] VARIANT_BOOL DrawFame, [in] OLE_COLOR FrameColor, [in] long FrameThickness, [in] VARIANT_BOOL FillBody, [in] OLE_COLOR BodyColor, [in] long BodyOpacity);

Description

With SetSignatureFrameParams you can define the layout of the signing frame/rectangle which is visible in the SignInDocument mode. This function allows you to remove the rectangle or to change its line colour and thickness. Furthermore, you can also define a different body colour and the opacity of the frame. The whole function only works in combination with SetSignDocMode and after the document was loaded.

Arguments

ArgumentDescription
DrawFame

Show a frame in FrameColor colour or not (True/False)

FrameColor

The value of the frame's colour

The value of the body's colour. this is a 32 Bit Value,

where

Bit 0 .. 7 is the red fraction,

Bit 8 .. 15 is the green fraction and

Bit 16 .. 23 is the blue fraction

f.e.: Red = 000000FFh, Blue = 00FF0000h

FrameThickness

The value of frame' thickness in pixel

FillBody

Fill frame body with the BodyColor colour and

the Opaqueness from BodyOpaque or not (True/False)

BodyColor

The value of the body's colour. this is a 32 Bit Value,

where

Bit 0 .. 7 is the red fraction,

Bit 8 .. 15 is the green fraction and

Bit 16 .. 23 is the blue fraction

f.e.: Red = 000000FFh, Blue = 00FF0000h

BodyOpacity

The body'S opacity value (0 to 100)

where

0 = full colour and

100 = NO colour (same as FillBody is false)

a good choice is 80


C# sample

AddSignature
// change the Layout of the signing rectangle on the Colour Devices
// Sample for colour values: Red(0x000000FF), Blue(0x00FF0000), Green(0x0000FF00), Yellow(0x0000FFFF)... 
 
bool drawframe = true;
uint colour = 0x000000FF;	// RED
int framethickness = 2;
bool fillbody = false;
uint bodyColour = 0;
int bodyOpacity = 0;
          
SignAPIv4.SetSignatureFrameParams(drawframe, colour, framethickness, fillbody, bodyColour, bodyOpacity);
SignAPIv4.SetSignDocMode(100, 100, 250, 200, 1);   
 
// Next step is to start Signing   
 
string padSettings = ""; 
bool Capturing = SigDev.startCapture("", true, true, true, true, ref ps);