visit Kofax web site
ACTIVESWLib::ISPGuiDisp

ACTIVESWLib::ISPGuiDisp Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiDispInterface ISPGuiDisp.

Display a signature in a window.


Public Member Functions

HRESULT Create ([in] __int64 hwndParent,[out, retval] long *result)
 Create a SPGuiDisp object (window).
HRESULT Create32 ([in] __int32 hwndParent,[out, retval] long *result)
 Create a SPGuiDisp object (window).
HRESULT CreateInClient ([in] __int64 hwndClient,[in] __int64 hwndParent,[out, retval] long *result)
 Create a SPGuiDisp object within an existing window.
HRESULT CreateInClient32 ([in] __int32 hwndClient,[in] __int32 hwndParent,[out, retval] long *result)
 Create a SPGuiDisp object within an existing window.
HRESULT GetBackgroundColor ([out] long *piColor,[out, retval] long *result)
 Get the background color of this SPGuiDisp object.
HRESULT GetBoolProperty ([in] BSTR bstrName,[out] long *piValue,[out, retval] long *result)
 Query a property.
HRESULT GetBorder ([out] long *piBorder,[out, retval] long *result)
 Get the size of the border in the SPGuiDisp object [in screen pixel].
HRESULT GetDrawMode ([out] long *piDrawMode,[out, retval] long *result)
 Get the current draw mode in the SPGuiDisp object.
HRESULT GetForegroundColor ([out] long *piColor,[out, retval] long *result)
 Get the foreground color of this SPGuiDisp object.
HRESULT GetHwnd ([out] __int64 *pHwnd,[out, retval] long *result)
 get the window handle of the window associated with the SPGuiDisp object
HRESULT GetHwnd32 ([out] __int32 *pHwnd,[out, retval] long *result)
 get the window handle of the window associated with the SPGuiDisp object
HRESULT GetIntProperty ([in] BSTR bstrName,[out] long *piValue,[out, retval] long *result)
 Query a property.
HRESULT SetBackgroundColor ([in] long iColor,[out, retval] long *result)
 Set the background color of this SPGuiDisp object.
HRESULT SetBoolProperty ([in] BSTR bstrName,[in] long iValue,[out, retval] long *result)
 Set a property.
HRESULT SetBorder ([in] long iBorder,[out, retval] long *result)
 Set the size of the border in the SPGuiDisp object [in screen pixel].
HRESULT SetDrawMode ([in] long iDrawMode,[out, retval] long *result)
 Set the draw mode of a SPGuiDisp object.
HRESULT SetForegroundColor ([in] long iColor,[out, retval] long *result)
 Set the foreground color of this SPGuiDisp object.
HRESULT SetImage ([in] ISPImage *pImage,[out, retval] long *result)
 set the image to be displayed in the SPGuiDisp object
HRESULT SetIntProperty ([in] BSTR bstrName,[in] long iValue,[out, retval] long *result)
 Set a property.
HRESULT SetSignature ([in] ISPSignature *pSignature,[out, retval] long *result)
 set the signature to be displayed in the SPGuiDisp object
HRESULT SetSplitLines (SAFEARRAY(LONG)*pSplitPosition,[out, retval] long *result)
 Pass an array of split positions.
HRESULT SetWeight ([in] double dWeight,[out, retval] long *result)
 Set The weight.
HRESULT SetWeightedFrames ([in] ISPWeightedFrames *pFrames,[out, retval] long *result)
 Pass an array of weighted frames.

Member Function Documentation

HRESULT ACTIVESWLib::ISPGuiDisp::Create (  [in] __int64  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiDisp object (window).

Parameters:
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispCreate, CreateInClient

HRESULT ACTIVESWLib::ISPGuiDisp::Create32 (  [in] __int32  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiDisp object (window).

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispCreate, CreateInClient

HRESULT ACTIVESWLib::ISPGuiDisp::CreateInClient (  [in] __int64  hwndClient,
[in] __int64  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiDisp object within an existing window.

Parameters:
hwndClient [i] Window handle of the child window that will be subclassed to provide for the functionality
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispCreateInClient, Create

HRESULT ACTIVESWLib::ISPGuiDisp::CreateInClient32 (  [in] __int32  hwndClient,
[in] __int32  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiDisp object within an existing window.

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
hwndClient [i] Window handle of the child window that will be subclassed to provide for the functionality
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispCreateInClient, Create

HRESULT ACTIVESWLib::ISPGuiDisp::GetBackgroundColor (  [out] long *  piColor,
[out, retval] long *  result
) 
 

Get the background color of this SPGuiDisp object.

Parameters:
piColor [i] a pointer to an SPINT32, that will be filled with the background color
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispGetBackgroundColor, SetBackgroundColor

HRESULT ACTIVESWLib::ISPGuiDisp::GetBoolProperty (  [in] BSTR  bstrName,
[out] long *  piValue,
[out, retval] long *  result
) 
 

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDisp Properties
piValue [i] pointer to avariable that will be filled with the value of the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPGuiDisp::GetBorder (  [out] long *  piBorder,
[out, retval] long *  result
) 
 

Get the size of the border in the SPGuiDisp object [in screen pixel].

Parameters:
piBorder [o] a pointer to a SPINT32, that will be filled with the border size
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
Note:
Default Border is 5 pixels
See also:
SPGuiDispGetBorder, SetBorder

HRESULT ACTIVESWLib::ISPGuiDisp::GetDrawMode (  [out] long *  piDrawMode,
[out, retval] long *  result
) 
 

Get the current draw mode in the SPGuiDisp object.

Parameters:
piDrawMode [o] a pointer to a SPINT32, that will be filled with the current draw mode
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispGetDrawMode, SetDrawMode

HRESULT ACTIVESWLib::ISPGuiDisp::GetForegroundColor (  [out] long *  piColor,
[out, retval] long *  result
) 
 

Get the foreground color of this SPGuiDisp object.

Parameters:
piColor [i] a pointer to an SPINT32, that will be filled with the foreground color
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispGetForegroundColor, SetForegroundColor

HRESULT ACTIVESWLib::ISPGuiDisp::GetHwnd (  [out] __int64 *  pHwnd,
[out, retval] long *  result
) 
 

get the window handle of the window associated with the SPGuiDisp object

Parameters:
pHwnd [o] a pointer to a window handle, that will be filled with the window handle that is associated with the SPGui object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_NOERR successfull completion
  • SPX_PARAMERR invalid parameter
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispGetHwnd

HRESULT ACTIVESWLib::ISPGuiDisp::GetHwnd32 (  [out] __int32 *  pHwnd,
[out, retval] long *  result
) 
 

get the window handle of the window associated with the SPGuiDisp object

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
pHwnd [o] a pointer to a window handle, that will be filled with the window handle that is associated with the SPGui object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispGetHwnd

HRESULT ACTIVESWLib::ISPGuiDisp::GetIntProperty (  [in] BSTR  bstrName,
[out] long *  piValue,
[out, retval] long *  result
) 
 

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDisp Properties
piValue [i] pointer to avariable that will be filled with the value of the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPGuiDisp::SetBackgroundColor (  [in] long  iColor,
[out, retval] long *  result
) 
 

Set the background color of this SPGuiDisp object.

Parameters:
iColor [i] the background color, format 0xrrggbb bb = blue, gg = green, rr = red, each color in range 0 .. 0xff
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispSetBackgroundColor, GetBackgroundColor

HRESULT ACTIVESWLib::ISPGuiDisp::SetBoolProperty (  [in] BSTR  bstrName,
[in] long  iValue,
[out, retval] long *  result
) 
 

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDisp Properties
iValue [i] the value of the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPGuiDisp::SetBorder (  [in] long  iBorder,
[out, retval] long *  result
) 
 

Set the size of the border in the SPGuiDisp object [in screen pixel].

Parameters:
iBorder [i] the new border size
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
Note:
Default Border is 5 pixels
See also:
SPGuiDispSetBorder, GetBorder

HRESULT ACTIVESWLib::ISPGuiDisp::SetDrawMode (  [in] long  iDrawMode,
[out, retval] long *  result
) 
 

Set the draw mode of a SPGuiDisp object.

Parameters:
iDrawMode [i] drawing mode
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
Note:
The tablet area may be smaller than the window area, because the entry will be zoomed to keep the aspect ratio constant.
See also:
GetDrawMode, SPGuiDispGetDrawMode

HRESULT ACTIVESWLib::ISPGuiDisp::SetForegroundColor (  [in] long  iColor,
[out, retval] long *  result
) 
 

Set the foreground color of this SPGuiDisp object.

Parameters:
iColor [i] the foreground color, format 0xrrggbb bb = blue, gg = green, rr = red, each color in range 0 .. 0xff
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispSetForegroundColor, GetForegroundColor

HRESULT ACTIVESWLib::ISPGuiDisp::SetImage (  [in] ISPImage *  pImage,
[out, retval] long *  result
) 
 

set the image to be displayed in the SPGuiDisp object

Parameters:
pImage [i] a valid ISPImage object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispSetImage, SetSignature

HRESULT ACTIVESWLib::ISPGuiDisp::SetIntProperty (  [in] BSTR  bstrName,
[in] long  iValue,
[out, retval] long *  result
) 
 

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDisp Properties
iValue [i] the value of the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPGuiDisp::SetSignature (  [in] ISPSignature *  pSignature,
[out, retval] long *  result
) 
 

set the signature to be displayed in the SPGuiDisp object

Parameters:
pSignature [i] a valid ISPSignature object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
ISPSignature::CreateFromGuiDisp, SPGuiDispSetSignature, SetImage

HRESULT ACTIVESWLib::ISPGuiDisp::SetSplitLines (  SAFEARRAY(LONG)*  pSplitPosition,
[out, retval] long *  result
) 
 

Pass an array of split positions.

Parameters:
pSplitPosition [i] a pointer to an array of integers, each a split position
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispSetSplitLines, ISPImage::GetSplitPositions

HRESULT ACTIVESWLib::ISPGuiDisp::SetWeight (  [in] double  dWeight,
[out, retval] long *  result
) 
 

Set The weight.

Parameters:
dWeight [i] the new weight
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
Note:
All frames with a weight less than dWeight will be displayed
See also:
SPGuiDispSetWeight, SetWeightedFrames, ISPImage::GetFrames

HRESULT ACTIVESWLib::ISPGuiDisp::SetWeightedFrames (  [in] ISPWeightedFrames *  pFrames,
[out, retval] long *  result
) 
 

Pass an array of weighted frames.

Parameters:
pFrames [i] a pointer to an ISPWeightedFrames object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
Automation result, S_OK on success, else error code
See also:
SPGuiDispSetWeightedFrames, SetWeight, ISPImage::GetFrames

The documentation for this interface was generated from the following file: