visit Kofax web site
ACTIVESWLib::ISPGuiContainer

ACTIVESWLib::ISPGuiContainer Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiContainerInterface ISPGuiContainer.

Representation of the core SPGuiContainer object


Public Member Functions

HRESULT AddObject ([in] long lObjectType,[out, retval] long *result)
 Add a new Object in a SPGuiContainer.
HRESULT Create ([in] __int64 hwndChild,[in] __int64 hwndParent,[out, retval] long *result)
 Create the visible components of a SPGuiContainer object.
HRESULT Create32 ([in] __int32 hwndChild,[in] __int32 hwndParent,[out, retval] long *result)
 Create the visible components of a SPGuiContainer object.
HRESULT CreateObject ([in] long lIndex,[in] long lObjectType,[out, retval] long *result)
 Create a new Object in a SPGuiContainer at the specified index.
HRESULT FreeObject ([in] long lIndex,[out, retval] long *result)
 Free an Object in a SPGuiContainer at the specified index.
HRESULT GetBoolProperty ([in] BSTR bstrName,[out] long *piValue,[out, retval] long *result)
 Query a property.
HRESULT GetHwnd ([out] __int64 *pHwnd,[out, retval] long *result)
 Get the window handle of the window associated with an SPGuiContainer object.
HRESULT GetHwnd32 ([out] __int32 *pHwnd,[out, retval] long *result)
 Get the window handle of the window associated with an SPGuiContainer object.
HRESULT GetIntProperty ([in] BSTR bstrName,[out] long *piValue,[out, retval] long *result)
 Query a property.
HRESULT GetNumberObjects ([out] long *lNumberObjects,[out, retval] long *result)
 Query the number of objects in a SPGuiContainer.
HRESULT GetObject ([in] long lIndex,[out] IDispatch **pObject,[out] long *lObjectType,[out, retval] long *result)
 Query an Object in a SPGuiContainer at the specified index.
HRESULT SetActive ([in] long lIndex,[out, retval] long *result)
 Set the active object embedded in SPGuiContainer.
HRESULT SetBoolProperty ([in] BSTR bstrName,[in] long iValue,[out, retval] long *result)
 Set a property.
HRESULT SetIntProperty ([in] BSTR bstrName,[in] long iValue,[out, retval] long *result)
 Set a property.

Member Function Documentation

HRESULT ACTIVESWLib::ISPGuiContainer::AddObject (  [in] long  lObjectType,
[out, retval] long *  result
) 
 

Add a new Object in a SPGuiContainer.

Parameters:
lObjectType [i] Type of the new object, SPContainerObject :
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPGuiContainerAddObject

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

Create the visible components of a SPGuiContainer object.

Parameters:
hwndChild [i] Window handle of the child window that will be subclaessed 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
See also:
SPGuiContainerSetClient

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

Create the visible components of a SPGuiContainer object.

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
hwndChild [i] Window handle of the child window that will be subclaessed 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
See also:
SPGuiContainerSetClient

HRESULT ACTIVESWLib::ISPGuiContainer::CreateObject (  [in] long  lIndex,
[in] long  lObjectType,
[out, retval] long *  result
) 
 

Create a new Object in a SPGuiContainer at the specified index.

Parameters:
lIndex [i] zero based index
lObjectType [i] Type of the new object, SPContainerObject :
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPGuiContainerCreateObject

HRESULT ACTIVESWLib::ISPGuiContainer::FreeObject (  [in] long  lIndex,
[out, retval] long *  result
) 
 

Free an Object in a SPGuiContainer at the specified index.

Parameters:
lIndex [i] zero based index
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPGuiContainerFreeObject

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

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiContainer 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
See also:
SPGuiContainerGetBoolProperty

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

Get the window handle of the window associated with an SPGuiContainer object.

Parameters:
pHwnd [o] pointer to a variable that will be filled with the window handle of the window associated with the SPGuiContainer 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
See also:
SPGuiContainerGetHwnd

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

Get the window handle of the window associated with an SPGuiContainer 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] pointer to a variable that will be filled with the window handle of the window associated with the SPGuiContainer 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
See also:
SPGuiContainerGetHwnd

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

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiContainer 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
See also:
SPGuiContainerGetIntProperty

HRESULT ACTIVESWLib::ISPGuiContainer::GetNumberObjects (  [out] long *  lNumberObjects,
[out, retval] long *  result
) 
 

Query the number of objects in a SPGuiContainer.

Parameters:
lNumberObjects [o] will be filled with the nmber of objects
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPGuiContainerGetNumberObjects

HRESULT ACTIVESWLib::ISPGuiContainer::GetObject (  [in] long  lIndex,
[out] IDispatch **  pObject,
[out] long *  lObjectType,
[out, retval] long *  result
) 
 

Query an Object in a SPGuiContainer at the specified index.

Parameters:
lIndex [i] zero based index
pObject [o] will be filled with a reference to the object
lObjectType [o] will be filled with a type of the object, may be NULL, SPContainerObject
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPGuiContainerGetObject

HRESULT ACTIVESWLib::ISPGuiContainer::SetActive (  [in] long  lIndex,
[out, retval] long *  result
) 
 

Set the active object embedded in SPGuiContainer.

Parameters:
lIndex [i] zero based index
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPGuiContainerSetActive

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

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiContainer 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
See also:
SPGuiContainerSetBoolProperty

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

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiContainer 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
See also:
SPGuiContainerSetIntProperty

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