<Image variable>.DrawRectangle (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Coordinates

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Image variable>.DrawRectangle (Function)

In french: <Variable Image>.DessineRectangle

Draws a rectangle in an Image variable.

Versions 25 and later

This function is now available for Android applications.

This function is now available for Java applications.

New in version 25

This function is now available for Android applications.

This function is now available for Java applications.

This function is now available for Android applications.

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 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.

The syntax that manages the Rectangle and the Color types is now available for Java applications.

New in version 24

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

The syntax that manages the Rectangle and the Color types is now available for Java applications.

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

The syntax that manages the Rectangle and the Color types is now available for Java applications.

Example

MyImage is Image = "Test.gif"

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

IMG_MyDrawing = MyImage

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 variable to use.

<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 <Image variable>.Background 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 <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 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 <Image variable>.Pen 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 <Image variable>.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 ThicknessUndefined constant, the thickness defined during the last call to <Image variable>.Pen 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 <Image variable>.Pen 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 <Image variable>.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 ThicknessUndefined constant, the thickness defined during the last call to <Image variable>.Pen 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 <Image variable>.Pen 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 <Image variable>.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 ThicknessUndefined constant, the thickness defined during the last call to <Image variable>.Pen 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 <Image variable>.Pen is used. If this function has not been used, the line will be solid.

characteristics specified in the last call to <Image variable>.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 variable to use.

<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 <Image variable>.Background has not been 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 <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 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 <Image variable>.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 corresponds to the ColorUndefined constant, the color defined during the last call to <Image variable>.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 ThicknessUndefined constant, the thickness defined during the last call to <Image variable>.Pen is 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 <Image variable>.Pen will be used. If this function has not been used, the line will be solid.

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

Remarks

Coordinates

Coordinates are given with respect to the top left corner of the image (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 : wd250pnt.dll