GetCellSpan Method
Applies To
fpSpread control
Description
Returns whether the specified cell is in a span of cells, and returns the anchor cell and the number of cells in the span range.
Syntax
long CSpreadSheet::GetCellSpan(long lCol, long lRow, VARIANT* pvColAnchor, VARIANT* pvRowAnchor, VARIANT* pvNumCols, VARIANT* pvNumRows);
fpSpread1.GetCellSpan(ByVal lCol As Long, ByVal lRow As Long, pvColAnchor As Variant, pvRowAnchor As Variant, pvNumCols As Variant, pvNumRows As Variant) As GetCellSpanConstants
Parameters
The following parameters are available:
Parameter | Description |
---|---|
lCol | Column number of cell about which to return span information |
lRow | Row number of cell about which to return span information |
pvColAnchor | Column number of anchor cell for span |
pvRowAnchor | Row number of anchor cell for span |
pvNumCols | Number of columns in the span range |
pvNumRows | Number of rows in the span range |
Remarks
Call the GetCellSpan method to return whether a cell is in a span of cells, and if it is in a span of cells, the column and row number of the anchor cell and the number of columns and rows in the span range.
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.
Create a span of cells by calling the AddCellSpan method. Remove a span of cells from the sheet by calling the RemoveCellSpan method.
Return Type
Returns one of the following values to provide information about the specified cell:
Value | Constant | Description |
---|---|---|
0 | GetCellSpanNo | Cell is not in a span |
1 | GetCellSpanYes | Cell is in a span |
2 | GetCellSpanAnchor | Cell is the anchor cell for the span |
See Also
Sheet property
AddCellSpan, RemoveCellSpan methods
DLL Correspondence
SSGetCellSpan function