SSGetShowScrollTips, SSSetShowScrollTips Functions
Applies To
fpSpread DLL control
Description
Set or return whether scroll tips appear when the user moves the scroll box.
Syntax
WORD SSGetShowScrollTips(HWND hWnd);
void SSSetShowScrollTips(HWND hWnd, WORD wScrollTips);
WORD TSpread::GetShowScrollTips( );
void TSpread::SetShowScrollTips(WORD wScrollTips);
Parameters
The following parameters are available:
Parameter | Description | ||
hWnd | Window handle of the fpSpread control | ||
wScrollTips | Specifies whether scroll tips appear Use one of the following values |
||
Value | Constant | Description | |
0 | SS_SHOWSCROLLTIPS_OFF | (Default) Scroll tips do not appear as you move the scroll box | |
1 | SS_SHOWSCROLLTIPS_VERT | Scroll tips appear as you move the scroll box on the vertical scroll bar only | |
2 | SS_SHOWSCROLLTIPS_HORZ | Scroll tips appear as you move the scroll box on the horizontal scroll bar only | |
3 | SS_SHOWSCROLLTIPS_BOTH | Scroll tips appear as you move the scroll box on the horizontal or vertical scroll bar |
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.
By default, the sheet does not display scroll tips as you move the scroll box on either scroll bar. Set the SSShowScrollTips function's wScrollTips parameter to a value other than 0 (SS_SHOWSCROLLTIPS_OFF) to make scroll tips appear when the user moves the horizontal or vertical scroll box or both.
The scroll tip displays "Column: nn" for the horizontal scroll bar and "Row: nn" for the vertical scroll bar, where "nn" is the column or row designation. For example, scrolling along the vertical scroll bar could display a scroll tip of "Row: 48".
The SSShowScrollTips function uses the Windows system colors for background and face for the scroll tips' background and text colors. You cannot modify these color values for the scroll tips.
The SSShowScrollTips function uses the Windows system font for displaying the scroll tips' text. You cannot modify the font or size values for the scroll tips.
Note that the SSM_TEXTTIPFETCH message is not sent when the control displays the scroll tips. The SSM_TEXTTIPFETCH message is sent only for text tips and cell notes.
Return Value
Previous value (refer to the wScrollTips parameter for an explanation of the available return values).
See Also
SSSetBool (SSB_SCROLLBAREXTMODE, SSB_SCROLLBARMAXALIGN, SSBHORZSCROLLBAR, SSB_VERTSCROLLBAR, SSB_SCROLLBARSHOWMAX, SSB_HSCROLLBARTRACK, SSB_VSCROLLBARTRACK), SSSetSheet functions
SSM_TEXTTIPFETCH message
ActiveX Correspondence
ShowScrollTips property