VpeSetBkgGradientStartColor

<< Click to Display Table of Contents >>

Navigation:  Drawing Functions >

VpeSetBkgGradientStartColor

Previous pageReturn to chapter overviewNext page

[Not supported by the Community Edition]

Specifies the gradient start color. To make the gradient painted, the Background Mode must be set to a gradient mode.

void VpeSetBkgGradientStartColor(

VpeHandle hDoc,

COLORREF color_start

)

VpeHandle hDoc

Document Handle or VPE Object Handle

COLORREF color_start

one of the predefined "COLOR_xyz" constants described in Programmer's Manual or any RGB value

Default:

COLOR_WHITE (but the Transparent Background Mode is activated!)

Remarks:

Gradients do only work for rectangular objects like Boxes, Text, Ellipses, etc. Gradients are not drawn in Pies and Polygons. If a gradient mode is selected, hatching for the same object is not possible.

Example:

VpeSetBkgMode(hDoc, VBKG_GRD_LINE)

VpeSetBkgGradientStartColor(hDoc, COLOR_BLUE)

VpeSetBkgGradientEndColor(hDoc, COLOR_GREEN)

VpePrintBox(hDoc, 1, 1, "Hello World!")

Will draw the text "Hello World!" with a gradient running from blue to green in the background.