dRectangle (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Functions for handling graphic strings

Using the drawing functions

Pattern and PHP

Drawing in Browser code

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 25 and later
in a WDPic variable (on the background layer),
New in version 25
in a WDPic variable (on the background layer),
in a WDPic variable (on the background layer),
Versions 25 and later
in a picLayer variable.
New in version 25
in a picLayer variable.
in a picLayer variable.

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 16 and later

This function is now available in Browser code.

New in version 16

This function is now available in Browser code.

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.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. Only the background layer will be handled.
Versions 25 and later
the name of a picLayer variable.
New in version 25
the name of a picLayer variable.
the name of a picLayer variable.
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.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. Only the background layer will be handled.
Versions 25 and later
the name of a picLayer variable.
New in version 25
the name of a picLayer variable.
the name of a picLayer variable.
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.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. Only the background layer will be handled.
Versions 25 and later
the name of a picLayer variable.
New in version 25
the name of a picLayer variable.
the name of a picLayer variable.
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 has not been 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 has not been 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 has not been used, the background color of the rectangle will be 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 has not been used, the thickness will be set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen is used. If this function has not been used, the line will be solid.

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 has not been used, the background color of the rectangle will be 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 has not been used, the thickness will be set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen is used. If this function has not been used, the line will be solid.

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 has not been used, the background color of the rectangle will be 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 has not been used, the thickness will be set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen is used. If this function has not been used, the line will be solid.

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.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. Only the background layer will be handled.
Versions 25 and later
the name of a picLayer variable.
New in version 25
the name of a picLayer variable.
the name of a picLayer variable.
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.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. Only the background layer will be handled.
Versions 25 and later
the name of a picLayer variable.
New in version 25
the name of a picLayer variable.
the name of a picLayer variable.
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.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. Only the background layer will be handled.
Versions 25 and later
the name of a picLayer variable.
New in version 25
the name of a picLayer variable.
the name of a picLayer variable.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<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 preset color of WLanguage,
a Color variable,
transparent if this parameter is not specified and if dBackground has not been used beforehand.
Characteristics of background:
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 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 corresponds to the ColorUndefined constant, the color defined during the last call to dPen 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 ThicknessUndefined constant, the thickness defined during the last call to dPen will be used. If this function has not been used, the thickness will be set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line defined during the last call to dPen is used. If this function has not been used, the line will be solid.

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. The dStartDrawing function becomes unnecessary. This function must be deleted.

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. The dStartDrawing function becomes unnecessary. This function must be deleted.

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. The dStartDrawing function becomes unnecessary. This function must be deleted.

Pattern and PHP

In PHP, the drawing functions are based on the graphic library GD. This library is commonly used by the PHP hosting companies and therefore it is always enabled. The version of the GD library must be version 2.0.28 (or later). This library can be downloaded from the PHP site.

To enable (if necessary) this library locally, the following elements are required:

PHP installed.
the PHP.INI file found in the Windows directory must contain the following line: "extension=php_gd2.dll" (instead of ";extension=php_gd2.dll").
the php_gd2.dll file must exist in the directory of PHP extensions. This directory is defined in the PHP.INI file by the "extension_dir" variable.

Versions 16 and later

Drawing in Browser code

Some drawing functions are available in Browser code. The drawing functions in Browser code are based on the HTML 5 standard. More specifically, these functions are based on the "canvas" tag of HTML 5.

The drawing features in browser code are available for the recent browsers only (supporting the HTML 5 standard). To find out whether the drawing features are proposed by your browser, use DrawingAvailable.

Caution: To use the drawing functions with Internet Explorer 9, the project must include the reference to the DTD file. To do so, the HTML mode must be "HTML 4.01 Transitional + DTD". This option is available in the "Advanced" tab of the description window of project.
Reminder: To open the project description window, go to the "Project" pane, "Project" group and click "Description".

Special case: Drawing in the browser of an Android phone: The browser drawing functions are only available starting with version 3 of Android.

New in version 16

Drawing in Browser code

Special case: Drawing in the browser of an Android phone: The browser drawing functions are only available starting with version 3 of Android.

Drawing in Browser code

Special case: Drawing in the browser of an Android phone: The browser drawing functions are only available starting with version 3 of Android.

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