SSGetSelectBlock, SSSetSelectBlock Functions

Applies To

fpSpread DLL control

Description

Set or return the upper-left and lower-right cell positions of a block selection.

Syntax

BOOL SSGetSelectBlock(HWND hWnd, LPSS_CELLCOORD CellUL, LPSS_CELLCOORD CellLR);

BOOL SSSetSelectBlock(HWND hWnd, LPSS_CELLCOORD CellUL, LPSS_CELLCOORD CellLR);

C++

BOOL TSpread::GetSelectBlock(LPSS_CELLCOORD CellUL, LPSS_CELLCOORD CellLR);

BOOL TSpread::SetSelectBlock(LPSS_CELLCOORD CellUL, LPSS_CELLCOORD CellLR);

Parameters

These functions have the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
CellUL	Pointer to variable that receives upper-left cell's row and column numbers
CellLR	Pointer to variable that receives lower-right cell's row and column numbers

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.

Use the SSSetSelectBlock function to select a block of cells. Specify the upper-left cell of the block with the CellUL parameter. Specify the lower-right cell of the block with the CellLR parameter.

These functions have an effect only when the sheet is in normal operation mode.

If the SSSetBool SSB_ALLOWMULTIBLOCKS option is TRUE and you use the SSGetSelectBlock function, it only returns the last selected block. Use the SSGetMultiSelBlocks function to return all selected blocks.

Return Value

TRUE if the function completes successfully; FALSE otherwise.

ActiveX Correspondence

SSGetSelectBlock: IsBlockSelected, SelBlockCol, SelBlockCol2, SelBlockRow, SelBlockRow2 properties

SSSetSelectBlock: SetSelection method