dRectangle (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Functions for handling graphic strings

Using the drawing functions

Related examples

See also

dRectangle (Function)

In french: dRectangle

Draws a rectangle:

in an Image control,
in an Image variable.
This type of variable is not available.

Versions 16 and later

This function is now available for Android applications.

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Android applications.

This function is now available for Windows Phone applications.

This function is now available for Android applications.

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

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 Rectangle and the Color type is now available for Android applications.

New in version 24

The syntax that manages the Rectangle and the Color type is now available for Android applications.

Example

See additional examples

// Initialize the drawing in an Image control
dStartDrawing(IMG_Drawing)

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

Versions 24 and later

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

New in version 24

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

Syntax

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

dRectangle([<Image>, ] <X1> , <Y1> , <X2> , <Y2> [, <Background> [, <Line>]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Versions 24 and later
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
This type of variable is not available.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
New in version 24
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
This type of variable is not available.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
This type of variable is not available.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<X1>: Integer

X coordinate (in pixels) of top left corner of rectangle.

<Y1>: Integer

Y coordinate (in pixels) of top left corner of rectangle.

<X2>: Integer

X coordinate (in pixels) of bottom right corner of rectangle.

<Y2>: Integer

Y coordinate (in pixels) of bottom right corner of 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 preset color of WLanguage,
Versions 22 and later
a Color variable,
New in version 22
a Color variable,
a Color variable,
transparent if this parameter is not specified and if dBackground was not used beforehand.
Characteristics of background:
Versions 21 and later
Background variable. In this case, the gradient defined in the variable is ignored.
New in version 21
Background variable. In this case, the gradient defined in the variable is ignored.
Background variable. In this case, the gradient defined in the variable is ignored.
characteristics specified in the last call to dBackground if this parameter is not specified.
To use a gradient background color, call dRectangleGradient.

<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 preset color of WLanguage,
Versions 22 and later
a Color variable,
New in version 22
a Color variable,
a Color variable,
identical to the color used for the background if this parameter is not specified and if dPen was not used.
Characteristics of the line:
Versions 21 and later
Border variable. In this case, only the following properties are taken into account:
Color: if the property corresponds to the ColorUndefined constant, the color defined during the last call to dPen is used. If this function was not used, the background color of the rectangle is used.
Thickness: if the property corresponds to the ThicknessUndefined constant, the thickness defined during the last call to dPen will be used. If this function was not used, the thickness is set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen will be used. If this function was not used, the line is a solid line.

New in version 21
Border variable. In this case, only the following properties are taken into account:
Color: if the property corresponds to the ColorUndefined constant, the color defined during the last call to dPen is used. If this function was not used, the background color of the rectangle is used.
Thickness: if the property corresponds to the ThicknessUndefined constant, the thickness defined during the last call to dPen will be used. If this function was not used, the thickness is set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen will be used. If this function was not used, the line is a solid line.

Border variable. In this case, only the following properties are taken into account:
Color: if the property corresponds to the ColorUndefined constant, the color defined during the last call to dPen is used. If this function was not used, the background color of the rectangle is used.
Thickness: if the property corresponds to the ThicknessUndefined constant, the thickness defined during the last call to dPen will be used. If this function was not used, the thickness is set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen will be used. If this function was not used, the line is a solid line.

characteristics specified in the last call to dPen if this parameter is not specified.

Drawing a rectangle via a Rectangle variable Hide the details

dRectangle([<Image>, ] <Rectangle> [, <Background> [, <Line>]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Versions 24 and later
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
This type of variable is not available.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
New in version 24
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
This type of variable is not available.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
This type of variable is not available.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Rectangle>: Rectangle variable

Name of the Rectangle variable defining 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 preset color of WLanguage,
an Color variable,
transparent if this parameter is not specified and if dBackground was not used beforehand.
Characteristics of background:
Background variable. In this case, the gradient defined in the variable is ignored.
This type of variable is not available.
characteristics specified in the last call to dBackground if this parameter is not specified.
To use a gradient background color, call dRectangleGradient.

<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 preset color of WLanguage,
Versions 22 and later
a Color variable,
New in version 22
a Color variable,
a Color variable,
identical to the color used for the background if this parameter is not specified and if dPen was not used.
Characteristics of the line:
Border variable. In this case, only the following properties are taken into account:
Color: if the property corresponds to the ColorUndefined constant, the color defined during the last call to dPen is used. If this function was not used, the background color of the rectangle is used.
Thickness: if the property corresponds to the ThicknessUndefined constant, the thickness defined during the last call to dPen is used. If this function was not used, the thickness is set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen will be used. If this function was not used, the line is a solid line.

characteristics specified in the last call to dPen if this parameter is not specified.

Remarks

Coordinates

The coordinates are given in relation to the top left corner of the image or Image control ((0, 0) coordinates).

Using the drawing functions

The drawing functions can be used according to 2 methods:

Method 1: Using dStartDrawing
- dStartDrawing must be called before any other drawing function. dStartDrawing is used to define the element (Image control or variable) to which the drawing functions will be applied.
- When drawing on an Image control:
  - The drawing functions operate on a copy ("bitmap") of the image. You can use the drawing functions of Windows (via API or CallDLL32) but these functions must use the DC (Device Context) returned by dStartDrawing.
  - dEndDrawing and dStartDrawing must not be called in the same process.
    The drawing will not be displayed if dEndDrawing and dStartDrawing are called in the same process: it will be automatically erased.
Versions 24 and later
Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. dStartDrawing becomes useless. This function must be deleted.
Versions 25 and later
This syntax is now available.
New in version 25
This syntax is now available.
This syntax is now available.
New in version 24
Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. dStartDrawing becomes useless. This function must be deleted.
Versions 25 and later
This syntax is now available.
New in version 25
This syntax is now available.
This syntax is now available.
Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. dStartDrawing becomes useless. This function must be deleted.
Versions 25 and later
This syntax is now available.
New in version 25
This syntax is now available.
This syntax is now available.

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