CFGetRangeParam, ScriptCFGetRangeParam Methods
Applies To
fpSpread control
Description
Returns the column and row coordinates of a cell range reference parameter that is being passed into a custom function.
Syntax
void CSpreadSheet::CFGetRangeParam (short Param, long* Col, long* Row, long* Col2, long* Row2);
fpSpread.CFGetRangeParam(ByVal Param As Integer, Col As Long, Row As Long, Col2 As Long, Row2 As Long)
Note: The ScriptCFGetRangeParam 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 |
---|---|
Param | Index number of the parameter (The index of the first parameter is 1.) |
Col | Left column coordinate of range reference |
Row | Top row coordinate of range reference |
Col2 | Right column coordinate of range reference |
Row2 | Bottom row coordinate of range reference |
Remarks
This method can only be used inside the CustomFunction event handler.
You must use the CFGetParamInfo method to check the parameter status and type before calling the CFGetRangeParam method.
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.
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 ScriptCFGetRangeParam method. ScriptCFGetRangeParam method parameters that are not passed "ByVal" are declared as variants. |
Return Type
Returns the range coordinates in the Col, Row, Col2, and Row2 parameters.
See Also
Creating and Using Custom Functions
Sheet property
CustomFunction event
AddCustomFunction, AddCustomFunctionExt, CFGetCellParam, CFGetDoubleParam, CFGetDoubleParamExt, CFGetLongParam, CFGetParamInfo, CFGetStringParam, CFSetResult, EnumCustomFunction, GetCustomFunction, RemoveCustomFunction methods
ScriptEnhanced property