SpvGetGrayAreaMarginH, SpvSetGrayAreaMarginH Functions

Applies To

fpSpreadPreview DLL control

Description

Set or return the horizontal space between the displayed page and the edge of the control.

Syntax

int SpvGetGrayAreaMarginH(HWND hWnd, long FAR *lpValue);

int SpvSetGrayAreaMarginH(HWND hWnd, long value);

C++

long TPreview::GetGrayAreaMarginH(void);

int TPreview::SetGrayAreaMarginH(long value);

Parameters

The SpvGetGrayAreaMarginH function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpreadPreview control
lpValue	Pointer to variable that receives horizontal space between the displayed page and the edge of the control

The SpvSetGrayAreaMarginH function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpreadPreview control
value	Horizontal space between the displayed page and the edge of the control

Remarks

The default gray area horizontal margin is 720 twips.

Call the SpvSetGrayAreaMarginV function to set the vertical space between the displayed page and the edge of the control. Call the SpvSetPageGutterH and SpvSetPageGutterV functions to set the horizontal and vertical spaces between multiple pages.

The values you specify by calling the SpvSetGrayAreaMarginH and SpvSetGrayAreaMarginV functions are interpreted by the control according to the value set by the SpvSetGrayAreaMarginType function. By default, the settings for the margins are scaled to keep the page view readable within the preview area. However, you can change the setting of the SpvSetGrayAreaMarginType property to SPV_MARGINTYPE_ACTUAL to have the control use the exact settings of the SpvSetGrayAreaMarginH and SpvSetGrayAreaMarginV functions whether the page is zoomed in or out.

Return Value

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

ActiveX Correspondence

GrayAreaMarginH property