ZoomState Property
Applies To
fpSpreadPreview control
Description
Sets or returns the way the control zooms between different views of the displayed pages. This property is available at run time only.
Syntax
long CSpreadPreview::GetZoomState();
void CSpreadPreview::SetZoomState(long value);
[form.]fpSpreadPreview.ZoomState[ = setting%]
Remarks
The following settings are available:
| Setting | Description | Constant |
|---|---|---|
| 0 - Indeterminate | Control is not zoomed in or out | ZoomStateIndeterminate |
| 1 - In | Zooms to 100% | ZoomStateIn |
| 2 - Out | Zooms to a size smaller than 100% | ZoomStateOut |
| 3 - Switch | Zooms either in or out, depending on current view | ZoomStateSwitch |
The ZoomState property lets you programmatically zoom the view in or out (changes the percentage between 100% and a smaller percentage, depending on the view). The ZoomState property can specify to zoom in or out, or to switch from whatever the current view displays.
When the PageViewType is set to 2 (Percentage) and the PageViewPercentage property is set to 100, the ZoomState setting 1 (In) does not have an effect.
By default, users can zoom in or out by clicking a page in the preview area. You can prevent them from zooming using the mouse by setting the AllowUserZoom property to False.
Data Type
Integer (Enumerated)
See Also
AllowUserZoom, PageViewPercentage, PageViewType properties
DLL Correspondence
SpvGetZoomState, SpvSetZoomState functions