visit Kofax web site

SPWeightedFrames Class Reference

List of all members.

Detailed Description

PHP Wrapper around the COM object ActiveSW.SPWeightedFrames.

Note:
the class SPWeightedFrames requires a prior instance of a SPSignWare object
See also:
ACTIVESWLib.ISPWeightedFrames


Public Member Functions

 getBottom ($index)
 Query the bottom coordinate of a frame.
 getCount ()
 Query the number of frames in this object.
 getLeft ($index)
 Query the left coordinate of a frame.
 getRight ($index)
 Query the right coordinate of a frame.
 getTop ($index)
 Query the top coordinate of a frame.
 getWeight ($index)
 Query the weight of a frame.
 SPWeightedFrames ()
 Constructor
Exceptions:
Exception on errors.


Public Attributes

 $className = "SPWeightedFrames"
 Name of this class.
 $com = FALSE
 native COM handle


Constructor & Destructor Documentation

SPWeightedFrames.SPWeightedFrames  ) 
 

Constructor

Exceptions:
Exception on errors.


Member Function Documentation

SPWeightedFrames.getBottom index  ) 
 

Query the bottom coordinate of a frame.

Parameters:
$index [i] zero based index of the frame
Returns:
int, the bottom coordinate of the indexed frame
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPWeightedFrames.GetBottom

SPWeightedFrames.getCount  ) 
 

Query the number of frames in this object.

Returns:
int the number of frames
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPWeightedFrames.GetNumberEntries

SPWeightedFrames.getLeft index  ) 
 

Query the left coordinate of a frame.

Parameters:
$index [i] zero based index of the frame
Returns:
int, the left coordinate of the indexed frame
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPWeightedFrames.GetLeft

SPWeightedFrames.getRight index  ) 
 

Query the right coordinate of a frame.

Parameters:
$index [i] zero based index of the frame
Returns:
int, the right coordinate of the indexed frame
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPWeightedFrames.GetRight

SPWeightedFrames.getTop index  ) 
 

Query the top coordinate of a frame.

Parameters:
$index [i] zero based index of the frame
Returns:
int, the top coordinate of the indexed frame
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPWeightedFrames.GetTop

SPWeightedFrames.getWeight index  ) 
 

Query the weight of a frame.

Parameters:
$index [i] zero based index of the frame
Returns:
double, the weight of the indexed frame
Exceptions:
Exception on errors
See also:
ACTIVESWLib.ISPWeightedFrames.GetWeight


Member Data Documentation

SPWeightedFrames.$className = "SPWeightedFrames"
 

Name of this class.

SPWeightedFrames.$com = FALSE
 

native COM handle


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