<Image variable>.DrawRectangle (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Prefix syntax

Drawing functions on Image variables

DrawRectangle

Presentation

Example

Coordinates

Related examples

See also

<Image variable>.DrawRectangle (Function)

In french: <Variable Image>.DessineRectangle

Draws a rectangle in an Image control.

Caution: A specific configuration is required to use this function in Linux. For more details, see The drawings.

Example

// Draw a rectangle whose background is light yellow
// and whose border is light blue
IMG_Drawing.DrawRectangle(10, 10, 50, 50, LightYellow, LightBlue)

Syntax

Drawing a rectangle by specifying the coordinates of rectangle Hide the details

<Image variable>.DrawRectangle(<X1> , <Y1> , <X2> , <Y2> [, <Background> [, <Line>]])

<Image variable>: Image variable

Name of the Image control to be used.

<X1>: Integer

X-coordinate (in pixels) of the upper-left corner of the rectangle.

<Y1>: Integer

Y-coordinate (in pixels) of the upper-left corner of the rectangle.

<X2>: Integer

X-coordinate (in pixels) of the lower-right corner of the rectangle.

<Y2>: Integer

Y-coordinate (in pixels) of the lower-right corner of the rectangle.

<Background>: Integer, constant or Background variable (optional)

Background color of rectangle. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color,
transparent if this parameter is not specified and if <Image>.Background has not been used.
Background characteristics:
Background variable. In this case, the gradient defined in the variable is ignored.
Background variables are not available in this syntax. Use <Image>.DrawBorder to customize the background color.
characteristics specified in the last call to <Image>.Background if this parameter is not specified.
To use a gradient background color, call <Image>.DrawRectangleGradient.

<Line>: Integer, constant or Border variable (optional)

Color of rectangle line. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color,
identical to the color used for the background if this parameter is not specified and if <Image>.Pen has not been used.
Characteristics of the line:
Border variable. In this case, only the following properties are taken into account:
Color: if the property is set to ColorUndefined, the color defined in the last call to <Image>.Pen is used. If this function has not been used, the background color of the rectangle will be used.
Thickness: if the property is set to ThicknessUndefined, the thickness defined in the last call to <Image>.Pen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property is set to LineUndefined, the type of line defined in the last call to <Image>.Pen is used. If this function has not been used, the line will be solid.
Border variables are not available in this syntax. Use <Image>.DrawBorder to customize the borders.

characteristics specified in the last call to <Image>.Pen if this parameter is not specified.

Drawing a rectangle via a Rectangle variable Hide the details

<Image variable>.DrawRectangle(<Rectangle> [, <Background> [, <Line>]])

<Image variable>: Image variable

Name of the Image control to be used.

<Rectangle>: Rectangle variable

Name of the Rectangle variable that defines the coordinates of the rectangle to draw.

<Background>: Integer, constant or Background variable (optional)

Background color of rectangle. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color,
transparent if this parameter is not specified and if <Image>.Background has not been used.
Background characteristics:
Background variable. In this case, the gradient defined in the variable is ignored.
This type of variable is not available.
Background variables are not available in this syntax. Use <Image>.DrawBorder to customize the background color.
characteristics specified in the last call to <Image>.Background if this parameter is not specified.
To use a gradient background color, call <Image>.DrawRectangleGradient.

<Line>: Integer, constant or Border variable (optional)

Color of rectangle line. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color,
identical to the color used for the background if this parameter is not specified and if <Image>.Pen has not been used.
Characteristics of the line:
Border variable. In this case, only the following properties are taken into account:
Color: if the property is set to ColorUndefined, the color defined in the last call to <Image>.Pen is used. If this function has not been used, the background color of the rectangle will be used.
Thickness: if the property is set to ThicknessUndefined, the thickness defined in the last call to <Image>.Pen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property is set to LineUndefined, the type of line defined in the last call to <Image>.Pen is used. If this function has not been used, the line will be solid.
Border variables are not available in this syntax. Use <Image>.DrawBorder to customize the borders.
characteristics specified in the last call to <Image>.Pen if this parameter is not specified.

Remarks

Coordinates

Coordinates are specified with respect to the upper-left corner of the Image control (coordinates: (0,0)).

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

Business / UI classification: Neutral code

Component: wd270pnt.dll