<Image variable>.Background (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Image variable>.Background (Function)

In french: <Variable Image>.Fond

Declares the default background color for the rectangles, circles, ... used in an Variable type Image.

Versions 25 and later

This function is now available for Java applications.

New in version 25

This function is now available for Java applications.

Versions 15 and later

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The drawings for more details.

New in version 15

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The drawings for more details.

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. See The drawings for more details.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 24 and later

The syntax that manages the Color type is now available for Java applications.

New in version 24

The syntax that manages the Color type is now available for Java applications.

Example

MyImage is Image = "Test.gif"

// Declare the background color of different drawings
// made in the variable MyImage
MyImage.Background(LightGreen)

IMG_MyDrawing = MyImage

Syntax

<Image variable>.Background(<Color> [, <Fill style> [, <Type of hatching> [, <Opacity>]]])

<Image variable>: Image variable

Name of the Image variable to use.

<Color>: Integer or constant

Default background color of different drawings. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.
an Color variable. In this case, the opacity specified in the variable is taken into account.

<Fill style>: Optional integer or Integer constant

Default background fill of different drawings:
BackgroundHatched Background filled with hatching.
Corresponds to value 2 for compatibility.
BackgroundSolid
(Default value) Solid background.
Corresponds to value 0 for compatibility.
BackgroundTransparent Transparent background (<Color> is ignored).
Corresponds to value 1 for compatibility.

This value is ignored. In this version, you cannot hatch the background of a drawing.

<Type of hatching>: Optional integer

Type of background hatching used by default in the different drawings. To use this parameter, the value of <Fill style> must be equal to 2. If the value of <Fill style> is different from 2, <Type of hatching> is ignored. The different types of hatching are:
0: Horizontal hatching
1: Vertical hatching
2: Diagonal hatching at 60%
3: Diagonal hatching at 120%
4 (by default): Criss-crossed hatching
5: Diagonal crossed hatching
This value is ignored. In this version, you cannot hatch the background of a drawing.

<Opacity>: Optional integer

Opacity of color, included between 0 (transparent) and 255 (opaque). An opacity set to 128 is used to blend 50% of the color with the existing color found in the control.
Remarks:
This opacity will be taken into account if the drawing has been initialized with the constant dWithOpacity (function <Image variable>.StartDrawing).
Versions 23 and later
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.
New in version 23
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.

Related Examples:

Unit examples (WINDEV): The drawing functions

[ + ] Using the main drawing functions of WINDEV to:
- Initialize an Image control for drawing
- Draw simple shapes
- Write a text into a drawing
- Change the color in a drawing

Component: wd260pnt.dll