SSAddCellSpan Function

Applies To

fpSpread DLL control

Description

Adds a span of cells.

Syntax

BOOL SSAddCellSpan(HWND hWnd, SS_COORD lCol, SS_COORD lRow, SS_COORD lNumCols, SS_COORD lNumRows);

C++

BOOL TSpread::AddCellSpan(SS_COORD lCol, SS_COORD lRow, SS_COORD lNumCols, SS_COORD lNumRows);

Parameters

The following parameters are available:

Parameter	Description
hWnd	Window handle of the fpSpread control
lCol	Column number of cell at which to start the span
lRow	Row number of cell at which to start the span
lNumCols	Number of columns to span
lNumRows	Number of rows to span

Remarks

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.

Creating a span of cells creates one large cell where there had previously been several. For example, if you create a span of cells from cell A1 to cell C2, cell A1 then appears to occupy the space from cell A1 through cell C2, as shown in the following figure.

When you create a span of cells, the data in the first cell in the span (designated by the lCol and lRow parameters) occupies all the space in the span. When you create a span, the data that was in each of the cells in the span is still in each cell, but not displayed. The data is simply hidden by the span range. Also, the cell types of the cells combined in the span are not changed.

You can return whether a specified cell is in a span of cells by calling the SSGetCellSpan function. You can remove a span from a range of cells by calling the RemoveCellSpan function.

Note: You cannot sort a sheet that has spanned cells.

Return Value

TRUE if the function completes successfully; FALSE otherwise.

ActiveX Correspondence

AddCellSpan method