<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

Coordinates

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Image variable>.DrawRectangle (Function)

In french: <Variable Image>.DessineRectangle

Caution: In Linux, this function requires a specific configuration. For more details, see Drawing in WINDEV, WEBDEV and WINDEV Mobile.

Example

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

<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 variable>.Background has not been used.
Background characteristics:
variable of type Background. In this case, the gradient defined in the variable is ignored.
Background variables are not available in this syntax. Use <Image variable>.DrawBorder to customize the background color.
characteristics specified in the last call to <Image variable>.Background if this parameter is not specified.
To use a gradient background color, call <Image variable>.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:
variable of type Border. In this case, only the following properties are taken into account:
Color: if the Property corresponds to the constant UndefinedColorthe color defined during the last call to function <Image>.Pen is used. If this function has not been used, the background color of the rectangle will be used.
Thickness: if the Property corresponds to the constant ThicknessIndefinedthe thickness defined during the last call to function <Image>.Pen is used. If this function has not been used, the thickness will be set to 1.
Trait: if the property corresponds to TraitIndéfinithe stroke type defined during the last call to function <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 variable>.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

<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 variable>.Background has not been used.
Background characteristics:
variable of type Background. 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 variable>.DrawBorder to customize the background color.
characteristics specified in the last call to <Image variable>.Background if this parameter is not specified.
To use a gradient background color, call <Image variable>.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:
variable of type Border. In this case, only the following properties are taken into account:
Color: if the Property corresponds to the constant UndefinedColorthe color defined during the last call to function <Image>.Pen is used. If this function has not been used, the background color of the rectangle will be used.
Thickness: if the Property corresponds to the constant ThicknessIndefinedthe thickness defined during the last call to function <Image>.Pen is used. If this function has not been used, the thickness will be set to 1.
Trait: if the property corresponds to TraitIndéfinithe stroke type defined during the last call to function <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 variable>.DrawBorder to customize the borders.
characteristics specified in the last call to <Image>.Pen if this parameter is not specified.

Remarks

Coordinates

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: wd300pnt.dll