Spread 8.0 Documentation
SpvGetPagesPerScreen Function
Support Options
DLL Reference > DLL Functions > SpvGetPagesPerScreen Function

Glossary Item Box

SpvGetPagesPerScreen Function


See Also    ActiveX

Applies To

fpSpreadPreview DLL control

Description

Returns the number of pages the preview area can display at one time.

Syntax

C

int SpvGetPagesPerScreen(HWND hWnd, short FAR *lpValue);

C++

short TPreview::GetPagesPerScreen(void);

Parameters

The following parameters are available:

Parameter Description
hWnd Window handle of the fpSpreadPreview control
lpValue Pointer to variable that receives the number of pages displayed

Remarks

If you want to display multiple pages in the preview area of the control, call the SpvSetPageViewType function and set the value parameter to 5 (Multiple Pages). Then specify the number of pages displayed in the horizontal and vertical directions by calling the SpvSetPageMultiCntH and SpvSetPageMultiCntV functions.

Call this function to return the maximum number of pages that can be displayed in the preview area. For example, assume the fpSpreadPreview control displays 3 horizontal pages and 2 vertical pages and your sheet is 5 pages long. Five pages display in the preview area, but the SpvGetPagesPerScreen function returns 6.

If the SpvSetPageViewType function's value parameter is set to a value other than SPV_VIEWTYPE_MULTIPLEPAGES, the SpvGetPagesPerScreen function returns 1.

Return Value

For C users, 1 if the function completes successfully; 0 otherwise. For C++ users, the setting for the function.

See Also

SpvSetPageMultiCntH, SpvSetPageMultiCntV, SpvSetPageViewType functions

ActiveX Correspondence

PagesPerScreen property

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.