<WDPic variable>.DrawRectangle (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Coordinates
Pattern and PHP
Drawing in Browser code

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<WDPic variable>.DrawRectangle (Function)

In french: <Variable WDPic>.DessineRectangle

Draw a rectangle in an Variable of type WDPic (on the background layer).

Versions 15 and later

This function is now available for WEBDEV sites in Linux.

New in version 15

This function is now available for WEBDEV sites in Linux.

Example

MyWDPicImage is WDPic = "Test.gif"

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

IMG_MyDrawing = MyWDPicImage

Syntax

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

<WDPic image>.DrawRectangle(<X1> , <Y1> , <X2> , <Y2> [, <Background> [, <Line>]])

<WDPic image>: WDPic variable

Name of the WDPic variable to use. Only the background layer will be handled.

<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 the <WDPic variable>.Background function has not been used before.
Characteristics of background:
Versions 21 and later
Variable type Background. In this case, the gradient defined in the variable is ignored.
New in version 21
Variable type Background. In this case, the gradient defined in the variable is ignored.
Variable type Background. In this case, the gradient defined in the variable is ignored.
characteristics specified in the last call to <WDPic variable>.Background if this parameter is not specified.
To use a gradient background color, call <WDPic 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 Variable of type Color ,
New in version 22
a Variable of type Color ,
a Variable of type Color ,
same as Color used for Background if this parameter is not specified and if <WDPic variable>.Pen was not used.
Characteristics of the line:
Versions 21 and later
Variable type Border. In this case, only the following properties are taken into account:
Color: if the property corresponds to the constant ColorUndefined, the Color defined during the last call to the function <WDPic 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 constant ThicknessUndefined, the thickness defined during the last call to the function <WDPic variable>.Pen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property is LineUndefined, the type of Line defined during the last call to the <WDPic variable>.Pen function is used. If this function has not been used, the line will be solid.

New in version 21
Variable type Border. In this case, only the following properties are taken into account:
Color: if the property corresponds to the constant ColorUndefined, the Color defined during the last call to the function <WDPic 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 constant ThicknessUndefined, the thickness defined during the last call to the function <WDPic variable>.Pen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property is LineUndefined, the type of Line defined during the last call to the <WDPic variable>.Pen function is used. If this function has not been used, the line will be solid.

Variable type Border. In this case, only the following properties are taken into account:
Color: if the property corresponds to the constant ColorUndefined, the Color defined during the last call to the function <WDPic 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 constant ThicknessUndefined, the thickness defined during the last call to the function <WDPic variable>.Pen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property is LineUndefined, the type of Line defined during the last call to the <WDPic variable>.Pen function is used. If this function has not been used, the line will be solid.

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

Drawing a rectangle via a Rectangle variable Hide the details

<WDPic image>.DrawRectangle(<Rectangle> [, <Background> [, <Line>]])

<WDPic image>: WDPic variable

Name of the Variable type WDPic to handle. Only the background layer will be handled.

<Rectangle>: Rectangle variable

Name of the Variable of type Rectangle 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),
une preset color of WLanguage,
a Color variable,
transparent if this parameter is not specified and if the <WDPic variable>.Background function has not been used before.
Characteristics of background:
Background variable. In this case, the gradient defined in the variable is ignored.
characteristics specified in the last call to <WDPic variable>.Background if this parameter is not specified.
To use a gradient background color, call <WDPic 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),
une preset color of WLanguage,
Versions 22 and later
a Variable of type Color ,
New in version 22
a Variable of type Color ,
a Variable of type Color ,
same as Color used for Background if this parameter is not specified and <WDPic variable>.Pen was not used.
Characteristics of the line:
Variable type Border. In this case, only the following properties are taken into account:
Color: if the property corresponds to the constant ColorUndefined, the Color defined during the last call to the function <WDPic 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 constant ThicknessUndefined, the thickness defined during the last call to the function <WDPic variable>.Pen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property is LineUndefined, the type of Line defined during the last call to the <WDPic variable>.Pen function is used. If this function has not been used, the line will be solid.

characteristics specified in the last call to <WDPic 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: wd260pnt.dll