SSDelCol, SSDelColRange Functions
Applies To
fpSpread DLL control
Description
Deletes the specified column or columns.
Syntax
BOOL SSDelCol(HWND hWnd, SS_COORD Col);
BOOL SSDelColRange(HWND hWnd, SS_COORD Col, SS_COORD Col2);
BOOL TSpread::DelCol(SS_COORD Col);
BOOL TSpread::DelColRange(SS_COORD Col, SS_COORD Col2);
Parameters
The following parameters are available:
Parameter | Description |
hWnd | Window handle of the fpSpread control |
Col | Column number of column to delete |
Col2 | Column number of last column to delete if specifying a range for the SSDelColRange function |
This function is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet for which you are calling this function. To determine the settings you want for the Col and Col2 parameters, see Using Column and Row Properties.
Remarks
Use the SSDelColRange function to delete a range of columns.
When using the SSDelColRange function, make sure that the value of the Col parameter is less than the value of the Col2 parameter.
The SSDelCol and SSDelColRange functions do not change the maximum number of columns specified by the SSSetMaxCols function. When you use the SSDelCol or SSDelColRange functions to delete a column, a blank column is automatically added at the end of the sheet.
Return Value
TRUE if the function completes successfully; FALSE otherwise. The function returns FALSE if the column or columns to be deleted are beyond the last column that contains data.
See Also
SSDelRow, SSDelRowRange, SSSetSheet functions
ActiveX Correspondence
DeleteCols method