SSGetMultiSelBlocks, SSSetMultiSelBlocks Functions
Applies To
fpSpread DLL control
Description
Set or return the selected blocks in the sheet.
Syntax
HGLOBAL SSGetMultiSelBlocks(HWND hWnd, LPSHORT lpdSelBlockCnt);
BOOL SSSetMultiSelBlocks(HWND hWnd, LPSS_SELBLOCK lpSelBlockList, short dSelBlockCnt);
GLOBALHANDLE TSpread::GetMultiSelBlocks(LPSHORT lpdSelBlockCnt);
BOOL TSpread::SetMultiSelBlocks(LPSS_SELBLOCK lpSelBlockList, short dSelBlockCnt);
Parameters
The SSGetMultiSelBlocks function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| lpdSelBlockCnt | Pointer to the variable that receives the number of blocks in the list |
The SSSetMultiSelBlocks function has the following parameters:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
| lpSelBlockList | List of blocks to select (Each item in the list is a block. The blocks might or might not overlap. Either case is treated correctly.) |
| dSelBlockCnt | Number of cell blocks in the list |
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 SSGetMultiSelBlocks function to return a global handle that contains the array of selected blocks. When returned from the function, the lpdSelBlockCnt parameter contains the number of items in the array.
Use the SSSetMultiSelBlocks function to specify the selected blocks.
These functions have an effect only when the sheet is in normal operation mode.
Use the SSSetBool function and set the SSB_ALLOWMULTIBLOCKS option to TRUE to allow the user to select multiple blocks of cells. If the SSB_ALLOWMULTIBLOCKS option is FALSE, use the SSGetSelectBlock function to return the coordinates for cells in a single selected block, instead of the SSGetMultiSelBlocks function.
Return Value
SSGetMultiSelBlocks: Zero if an error occurred; otherwise, returns a valid global handle to a list of SS_SELBLOCK structures.
SSSetMultiSelBlocks: TRUE if the function completes successfully; FALSE otherwise.