GetInteger, ScriptGetInteger Methods
Applies To
fpSpread control
Description
Returns the value in a number cell as an integer value.
Syntax
BOOL CSpreadSheet::GetInteger(long Col, long Row, long* Value);
fpSpread.GetInteger(ByVal Col As Long, ByVal Row As Long, Value As Long) As Boolean
| Note: The ScriptGetInteger method uses the same syntax except method parameters that are not passed "ByVal" are declared as variants. For more information on Script methods, see Scripting Environment Usage. |
Parameters
The following parameters are available:
| Parameter | Description |
|---|---|
| Col | Column number of cell |
| Row | Row number of cell |
| Value | Returns the integer value |
Remarks
Use the GetInteger method to return the value of a number cell as an integer value. The Clip, ClipValue, Text, and Value properties return the value in a cell as a string. For more information about using these properties and methods, see Returning Data.
This method is called for the current sheet setting unless you first set the Sheet property to specify the sheet with which you want to work.
| Caution: Returning the integer portion of a number cell's value using the GetInteger method truncates the decimal portion of the value. |
| Tip: The GetInteger returns the value as a long data type. |
| Note: Call this method if you use the Spread control in a scripting environment (for example, Microsoft's Visual InterDev or Internet Explorer) or a non-scripting environment. However, if you want to use the Spread control in a scripting environment and you want to change any parameter that is not passed "ByVal", you must set the ScriptEnhanced property to True and call the ScriptGetInteger method. ScriptGetInteger method parameters that are not passed "ByVal" are declared as variants. For more information on Script methods, see Scripting Environment Usage. |
If you set the Col or Row parameter to –1 to return data from multiple cells, unless the cells were set with the Col or Row parameter set to –1, the method does not return a value.
Return Type
True if the integer value is returned in the Value parameter. If the integer value cannot be returned, the method returns False.
See Also
Clip, ClipValue, ScriptEnhanced, Sheet, Text, Value properties
GetText, SetInteger methods
DLL Correspondence
SSGetInteger function