SSGetFreeze, SSSetFreeze Functions
Applies To
fpSpread DLL control
Description
Set or return the number of nonscrolling, frozen rows or columns.
Syntax
BOOL SSGetFreeze(HWND hWnd, LPSS_COORD lpColsFrozen, LPSS_COORD lpRowsFrozen);
BOOL SSSetFreeze(HWND hWnd, SS_COORD ColsFrozen, SS_COORD RowsFrozen);
BOOL TSpread::GetFreeze(LPSS_COORD lpColsFrozen, LPSS_COORD lpRowsFrozen);
BOOL TSpread::SetFreeze(SS_COORD ColsFrozen, SS_COORD RowsFrozen);
Parameters
The SSGetFreeze function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| lpColsFrozen | Pointer to variable that receives number of frozen columns |
| lpRowsFrozen | Pointer to variable that receives number of frozen rows |
The SSSetFreeze function has the following parameters:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
| ColsFrozen | Number of columns to freeze |
| RowsFrozen | Number of rows to freeze |
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.
The SSSetFreeze function specifies the number of frozen rows and columns beginning at the header. You cannot freeze rows or columns in the middle of the sheet.
You cannot scroll through frozen rows and columns. These rows and columns are in addition to the header rows and columns, which are frozen by default.
Setting frozen rows and columns affects the value of the SSGetTopLeftCell function.
| Note: Frozen columns or rows print even if you specify a print range that does not include the frozen columns or rows. |
You cannot freeze rows when the Spread control is in virtual mode (when the SSSetBool function SSB_VIRTUALMODE option is TRUE).
Return Value
TRUE if the function completes successfully; FALSE otherwise.
See Also
SSSetBool (SSB_VIRTUALMODE), SSGetTopLeftCell, SSSetSheet functions
ActiveX Correspondence
ColsFrozen, RowsFrozen properties