visit Kofax web site

SPSignature Class Reference

List of all members.

Detailed Description

PHP Wrapper around the COM object ActiveSW.SPSignature.

Note:
the class SPSignature requires a prior instance of a SPSignWare object
See also:
ACTIVESWLib.ISPSignature


Public Member Functions

 create ()
 Create the native object.
 createClone ($aCom)
 Copy the native object.
 getImage ($dZoom=1.0)
 Query the signature as image.
 getImageSize (&$iWidth, &$iHeight)
 Query the size of a signature image (if the zoom would be 1.0).
 setPluginSignature ($strSignature)
 Create a SignWare signature from a captured signature.
 SPSignature ()

Public Attributes

 $className = "SPSignature"
 Name of this class.
 $com = false
 native COM handle


Constructor & Destructor Documentation

SPSignature.SPSignature  ) 
 

Constructor

Exceptions:
Exception on errors


Member Function Documentation

SPSignature.create  ) 
 

Create the native object.

Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPSignature.Create

SPSignature.createClone aCom  ) 
 

Copy the native object.

Parameters:
$aCom [i] object, the native (COM("ActiveSW.SPSignature")) handle to a signature object
Exceptions:
Exception on errors

SPSignature.getImage dZoom = 1.0  ) 
 

Query the signature as image.

Parameters:
$dZoom [i] zoom factor
Returns:
String the image data [gif format]
Exceptions:
Exception on errors
Note:
This SPSignature object must contain valid signatures, e. g. call setPluginSignature to fill this object
See also:
ACTIVESWLib.ISPSignature.GetImage

SPSignature.getImageSize &$  iWidth,
&$  iHeight
 

Query the size of a signature image (if the zoom would be 1.0).

Parameters:
$iWidth [o] will be filled with the width of the image [pix]
$iHeight [o] will be filled with the height of the image [pix]
Exceptions:
Exception on errors
Note:
This SPSignature object must contain valid signatures, e. g. call setPluginSignature to fill this object
See also:
ACTIVESWLib.ISPSignature.GetImageSize

SPSignature.setPluginSignature strSignature  ) 
 

Create a SignWare signature from a captured signature.

Parameters:
$strSignature [i] the captured signature data
Exceptions:
Exception on errors


Member Data Documentation

SPSignature.$className = "SPSignature"
 

Name of this class.

SPSignature.$com = false
 

native COM handle


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