gRectangle (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Graphic string management functions

gRectangle

Presentation

Example

Coordinates

Width/Height of rectangle

See also

gRectangle (Function)

In french: gRectangle

Builds a sequence of characters used to draw a rectangle.

In a window, this sequence of characters is used to draw a rectangle:

in an element found in a List Box or Combo Box control.
in the title bar and/or status bar of a window.
in a Static control.

Example

// Draw a rectangle in an element of "LIST_Shape"
// The rectangle background is light green and the border is light yellow
ListAdd(LIST_Shape, gRectangle(0, 0, 25, 18, LightGreen, LightYellow))

Syntax

<Result> = gRectangle(<X1> , <Y1> , <X2> , <Y2> [, <Background color> [, <Line color>]])

<Result>: Character string

Sequence of characters used to draw a rectangle.
This sequence of characters can be:
used in ListAdd, ListInsert or ListModify.
assigned to a Static control.
used in the title bar or status bar of a window.
This sequence of characters is not interpreted by the controls in WEBDEV. This function can be used to format the string returned by a WEBDEV Webservice consumed by a WINDEV or WINDEV Mobile application.

<X1>: Real

X-coordinate (in pixels) of the upper-left corner of the rectangle to draw.

<Y1>: Real

Y-coordinate (in pixels) of the upper-left corner of the rectangle to draw.

<X2>: Real

X-coordinate (in pixels) of the lower-right corner of the rectangle to draw.

<Y2>: Real

Y-coordinate (in pixels) of the lower-right corner of the rectangle to draw.

<Background color>: Integer or constant (optional)

Background color of rectangle. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
If this parameter is not specified, the background color corresponds to the background color of the current text (defined by gBackground).

<Line color>: Integer or constant (optional)

Color of rectangle line. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
If this parameter is not specified, the color of the line corresponds to the color of the current text (defined by gPen).

Remarks

Coordinates

All the coordinates are expressed in pixels in relation to the upper-left corner of the element where the rectangle will be drawn (upper-left corner of the row found in the List Box or Combo Box control for example).

Width/Height of rectangle

The width of the reference rectangle is set to <X2> - <X1>.

The height of the reference rectangle is set to <Y2> - <Y1>.

Component: wd270mdl.dll