Spread 8.0 Documentation
SpvGetPageBorderColor, SpvSetPageBorderColor Functions
Support Options
DLL Reference > DLL Functions > SpvGetPageBorderColor, SpvSetPageBorderColor Functions

Glossary Item Box

SpvGetPageBorderColor, SpvSetPageBorderColor Functions


See Also    ActiveX

Applies To

fpSpreadPreview DLL control

Description

Set or return the border color of the displayed pages

Syntax

C

int SpvGetPageBorderColor(HWND hWnd, COLORREF FAR *lpValue);

int SpvSetPageBorderColor(HWND hWnd, COLORREF value);

C++

COLORREF TPreview::GetPageBorderColor(void);

int TPreview::SetPageBorderColor(COLORREF value);

Parameters

The SpvGetPageBorderColor function has the following parameters:

Parameter Description
hWnd Window handle of the fpSpreadPreview control
lpValue Pointer to variable that receives the border color

The SpvSetPageBorderColor function has the following parameters:

Parameter Description
hWnd Window handle of the fpSpreadPreview control
value Border color
(Value can be SPREAD_COLOR_NONE, which specifies to use the default page border color.)

Remarks

The default page border color is 0x00800000 (dark blue).

Call the SpvSetPageBorderColor and SpvSetPageBorderWidth functions to change the color and width of the border around the displayed pages. Call the SpvSetPageShadowColor and SpvSetPageShadowWidth functions to change the color and width of the shadow behind the displayed pages.

This property does not have an effect unless the SpvSetPageBorderWidth function's Width parameter is set to a value greater than zero.

Return Value

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

See Also

SpvGetPageBorderWidth, SpvSetPageBorderWidth, SpvSetPageShadowColor, SpvSetPageShadowWidth functions

ActiveX Correspondence

PageBorderColor property

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