visit Kofax web site

ACTIVESWLib::ISPGuiDyn Interface Reference


Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiDynInterface ISPGuiDyn.

Display a dynamic features of a signature in a window.


Public Member Functions

HRESULT Create ([in] __int64 hwndParent,[out, retval] long *result)
 Create a SPGuiDyn object (window).
HRESULT Create32 ([in] __int32 hwndParent,[out, retval] long *result)
 Create a SPGuiDyn object (window).
HRESULT CreateInClient ([in] __int64 hwndClient,[in] __int64 hwndParent,[out, retval] long *result)
 Create a SPGuiDyn object within an existing window.
HRESULT CreateInClient32 ([in] __int32 hwndClient,[in] __int32 hwndParent,[out, retval] long *result)
 Create a SPGuiDyn object within an existing window.
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 SPGuiDyn object [in screen pixel].
HRESULT GetDrawMode ([out] long *piDrawMode,[out, retval] long *result)
 Get the current draw mode in the SPGuiDyn object.
HRESULT GetHwnd ([out] __int64 *pHwnd,[out, retval] long *result)
 get the window handle of the window associated with the SPGuiDyn object
HRESULT GetHwnd32 ([out] __int32 *pHwnd,[out, retval] long *result)
 get the window handle of the window associated with the SPGuiDyn object
HRESULT GetIntProperty ([in] BSTR bstrName,[out] long *piValue,[out, retval] long *result)
 Query a property.
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 SPGuiDyn object [in screen pixel.
HRESULT SetDrawMode ([in] long iDrawMode,[out, retval] long *result)
 Set the draw mode of a SPGuiDyn 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 SPGuiDyn object


Member Function Documentation

HRESULT ACTIVESWLib::ISPGuiDyn::Create [in] __int64  hwndParent,
[out, retval] long *  result
 

Create a SPGuiDyn 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: success, else error code
See also:
SPGuiDynCreate

HRESULT ACTIVESWLib::ISPGuiDyn::Create32 [in] __int32  hwndParent,
[out, retval] long *  result
 

Create a SPGuiDyn 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: success, else error code
See also:
SPGuiDynCreate

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

Create a SPGuiDyn 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: success, else error code
See also:
SPGuiDynCreateInClient, Create

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

Create a SPGuiDyn 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: success, else error code
See also:
SPGuiDynCreateInClient, Create

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

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDyn 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::ISPGuiDyn::GetBorder [out] long *  piBorder,
[out, retval] long *  result
 

Get the size of the border in the SPGuiDyn 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: success, else error code
Note:
Default Border is 5 pixels
See also:
SPGuiDynGetBorder, SetBorder

HRESULT ACTIVESWLib::ISPGuiDyn::GetDrawMode [out] long *  piDrawMode,
[out, retval] long *  result
 

Get the current draw mode in the SPGuiDyn 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: success, else error code
See also:
SPGuiDynGetDrawMode, SetDrawMode

HRESULT ACTIVESWLib::ISPGuiDyn::GetHwnd [out] __int64 *  pHwnd,
[out, retval] long *  result
 

get the window handle of the window associated with the SPGuiDyn 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:
Returns:
automation result, S_OK: success, else error code
See also:
SPGuiDynGetHwnd

HRESULT ACTIVESWLib::ISPGuiDyn::GetHwnd32 [out] __int32 *  pHwnd,
[out, retval] long *  result
 

get the window handle of the window associated with the SPGuiDyn 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: success, else error code
See also:
SPGuiDynGetHwnd

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

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDyn 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::ISPGuiDyn::SetBoolProperty [in] BSTR  bstrName,
[in] long  iValue,
[out, retval] long *  result
 

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDyn 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::ISPGuiDyn::SetBorder [in] long  iBorder,
[out, retval] long *  result
 

Set the size of the border in the SPGuiDyn 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: success, else error code
Note:
Default Border is 5 pixels
See also:
SPGuiDynSetBorder, GetBorder

HRESULT ACTIVESWLib::ISPGuiDyn::SetDrawMode [in] long  iDrawMode,
[out, retval] long *  result
 

Set the draw mode of a SPGuiDyn 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: success, else error code
Note:
: The draw Flags default to SP_DRAW_DX | SP_DRAW_DY | SPDRAW_DP | SP_DRAW_SPEED | SP_DRAW_DDX | SP_DRAW_DDY | SP_DRAW_ACCEL, if neither SP_DRAW_??? is spezified.
See also:
SPGuiDynSetDrawFlags, GetDrawFlags

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

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiDyn 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::ISPGuiDyn::SetSignature [in] ISPSignature pSignature,
[out, retval] long *  result
 

set the signature to be displayed in the SPGuiDyn object

Parameters:
pSignature [i] a valid pSPSIGNATURE_T 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: success, else error code
See also:
SPGuiDynSetSignature


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