SSGetEditMode, SSSetEditMode Functions
Applies To
fpSpread DLL control
Description
Set or return whether a cell is in edit mode.
Syntax
BOOL SSGetEditMode(HWND hWnd);
BOOL SSSetEditMode(HWND hWnd, BOOL fEditModeOn);
BOOL TSpread::GetEditMode(void);
BOOL TSpread::SetEditMode(BOOL fEditModeOn);
Parameters
The SSGetEditMode function has the following parameter:
Parameter | Description |
hWnd | Window handle of the fpSpread control |
The SSSetEditMode function has the following parameters:
Parameter | Description |
hWnd | Window handle of the fpSpread control |
fEditModeOn | New setting for edit mode |
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.
Edit mode is turned on for a cell when
- the user starts typing in the cell
- the user double-clicks the cell
- the SSSetEditMode function's fEditModeOn parameter is set to TRUE
Edit mode is turned off for a cell when
- the user presses the Enter key
- the user activates a different cell
- the application loses the focus
- the SSSetEditMode function's fEditModeOn parameter is set to FALSE
The edit mode setting indicates whether the user is currently editing the active cell. When edit mode is on, the active cell usually displays a flashing I-beam cursor. When edit mode is off, the active cell usually displays a focus rectangle.
You can specify which cell becomes the active cell when you press the Enter key to leave edit mode using the SSSetEditEnterAction function.
Return Value
SSGetEditMode: TRUE if the sheet is in edit mode; FALSE otherwise.
SSSetEditMode: TRUE if the function completes successfully; FALSE otherwise.
See Also
SSSetSheet function
ActiveX Correspondence
EditMode property