SpvGetAllowUserZoom, SpvSetAllowUserZoom Functions
Applies To
fpSpreadPreview DLL control
Description
Set or return whether the user can use the mouse to zoom in or out while viewing pages.
Syntax
int SpvGetAllowUserZoom(HWND hWnd, BOOL FAR *lpValue);
int SpvSetAllowUserZoom(HWND hWnd, BOOL value);
BOOL TPreview::GetAllowUserZoom(void);
int TPreview::SetAllowUserZoom(BOOL value);
Parameters
The following parameters are available:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| value | Specifies whether to allow the user to zoom |
Remarks
By default, the fpSpreadPreview control lets users zoom in and out in the view of the sheet pages.
If you set the value parameter to FALSE for the SpvSetAllowUserZoom function, users cannot zoom in or out by clicking the mouse while the pointer is over a preview page. However, you can still provide other means in the interface to let users zoom, such as a button that changes the SpvSetZoomState function's value parameter.
Return Value
SpvGetAllowUserZoom: For C users, TRUE if the function completes successfully; FALSE otherwise. For C++ users, TRUE if the user can zoom in and out; FALSE otherwise.
SpvSetAllowUserZoom: TRUE if the function completes successfully; FALSE otherwise.
See Also
SpvGetPageViewPercentage, SpvGetZoomState, SpvSetPageViewPercentage, SpvSetZoomState functions
ActiveX Correspondence
AllowUserZoom property