SSClear, SSClearRange Functions

Applies To

fpSpread DLL control

Description

Delete the data and clear the formatting for the specified cell or block of cells.

Syntax

BOOL SSClear(HWND hWnd, SS_COORD Col, SS_COORD Row);

BOOL SSClearRange(HWND hWnd, SS_COORD Col, SS_COORD Row, SS_COORD Col2, SS_COORD Row2);

C++

BOOL TSpread::Clear(SS_COORD Col, SS_COORD Row);

BOOL TSpread::ClearRange(SS_COORD Col, SS_COORD Row, SS_COORD Col2, SS_COORD Row2);

Parameters

The following parameters are available:

Parameter	Description
hWnd	Window handle of the fpSpread control
Col	Column number of cell or column number of upper-left cell of the block if specifying a block for the SSClearRange function
Row	Row number of cell or row number of upper-left cell of the block if specifying a block for the SSClearRange function
Col2	Column number of lower-right cell of the block if specifying a block for the SSClearRange function
Row2	Row number of lower-right cell of the block if specifying a block for the SSClearRange 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, Row, Col2, and Row2 parameters, see Using Column and Row Properties.

Remarks

Call the SSClearRange function to delete the data and clear the formatting for a block of cells.

These functions delete the data and clear the formatting from a cell, a column, a row, a block of cells, or the entire sheet. The formatting is reset to the default values for the column, row, block of cells, or sheet. For example, if you clear a cell with a blue background but the cell column's background is red, the cell's background becomes red after you clear the cell.

If you want to clear data and leave the current formatting, call the SSClearData or SSClearDataRange function.

Return Value

TRUE if the function completes successfully; FALSE otherwise.

ActiveX Correspondence

ClearRange method