SSGetActiveSheet, SSSetActiveSheet Functions
Applies To
fpSpread DLL control
Description
Set or return the active sheet.
Syntax
short SSGetActiveSheet(HWND hWnd);
BOOL SSSetActiveSheet(HWND hWnd, short nSheet);
short TSpread::GetActiveSheet( );
BOOL TSpread::SetActiveSheet(short nSheet);
Parameters
The SSGetActiveSheet function has the following parameter:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
The SSSetActiveSheet function has the following parameters:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
| nSheet | Sheet index of the sheet to become the active sheet |
Remarks
The active sheet is the sheet that receives user input. When the active sheet changes, the tab strip changes to display the tab for the active sheet as the first tab.
Call the SSGetActiveCell function to return the column and row number for the active cell.
The user can change the active sheet by clicking a sheet tab in the tab strip displayed at the bottom of the control, depending on the setting of the SSSetTabStripPolicy function's wTabStripPolicy parameter.
Return Value
SSGetActiveSheet: The sheet index of the active sheet.
SSSetActiveCellHighlightStyle: TRUE if the function completes successfully; FALSE otherwise.
See Also
SSShowActiveCell function
ActiveX Correspondence
ActiveSheet property