SSGetLockColor, SSSetLockColor Functions
Applies To
fpSpread DLL control
Description
Set or return the background and foreground colors displayed in locked cells.
Syntax
void SSGetLockColor(HWND hWnd, LPCOLORREF lpBackground, LPCOLORREF lpForeground);
void SSSetLockColor(HWND hWnd, COLORREF Background, COLORREF Foreground);
void TSpread::GetLockColor(LPCOLORREF lpBackground, LPCOLORREF lpForeground);
void TSpread::SetLockColor(COLORREF Background, COLORREF Foreground);
Parameters
The SSGetLockColor function has the following parameters:
Parameter | Description |
hWnd | Window handle of the fpSpread control |
lpBackground | Pointer to variable that receives background color of locked cells (Returns SPREAD_COLOR_NONE if default color is being used.) |
lpForeground | Pointer to variable that receives foreground color of locked cells (Returns SPREAD_COLOR_NONE if default color is being used.) |
The SSSetLockColor function has the following parameters:
Parameter | Description |
---|---|
hWnd | Window handle of the fpSpread control |
Background | Background color of locked cells (Value can be SPREAD_COLOR_NONE, which specifies locked cell uses cell, column, row, or sheet background color.) |
Foreground | Foreground color of locked cells (Value can be SPREAD_COLOR_NONE, which specifies locked cell uses cell, column, row, or sheet foreground color.) |
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 value specified by the SSSetLockColor function has an effect only when it is not set equal to SPREAD_COLOR_NONE, cells are marked as locked with the SSSetLock function, and the SSB_PROTECT boolean is set to TRUE.
If the Background or Foreground parameters for the SSSetLockColor function are set to SPREAD_COLOR_NONE, locked cells display the background or foreground colors specified by the Background or Foreground parameters of the SSSetColor or SSSetColorRange functions.
See Also
Setting Background and Text Colors for Locked Cells
SSSetColor, SSSetColorRange, SSSetLock, SSSetSheet functions
ActiveX Correspondence
LockBackColor, LockForeColor properties