dPen (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Graphic strings management functions

Using the drawing functions

Pattern and PHP

Drawing in Browser code

Related examples

See also

dPen (Function)

In french: dStylo

Declares the default color and style for the lines, rectangles, circles, ... found:

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 for Android applications.

This function is now available in Browser code.

New in version 16

This function is now available for Android applications.

This function is now available in Browser code.

This function is now available for Android applications.

This function is now available in Browser code.

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

The syntax that manages the Color type is now available for Java applications.

New in version 24

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

The syntax that manages the Color type is now available for Java applications.

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

The syntax that manages the Color type is now available for Java applications.

Example

See additional examples

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

// Declare the default color and style for the different lines
dPen(LightGreen, 3)

Versions 24 and later

// Declare the default color and style for the different lines
dPen(IMG_Drawing, LightGreen, 3)

New in version 24

// Declare the default color and style for the different lines
dPen(IMG_Drawing, LightGreen, 3)

Syntax

dPen([<Image>, ] <Color> [, <Line style> [, <Line thickness> [, <Opacity>]]])

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

<Color>: Integer or constant

Default color for the different lines. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.
Versions 23 and later
a Color variable. In this case, the opacity specified in the variable is taken into account.
Not available.
New in version 23
a Color variable. In this case, the opacity specified in the variable is taken into account.
Not available.
a Color variable. In this case, the opacity specified in the variable is taken into account.
Not available.

<Line style>: Optional integer

Default style for the different lines:
0 (by default): Solid line
1: Dash (---)
2: Dotted line (...)
3: Dot and dash (-.-.-)
4: Dash and two dots (-..-..-)
5: Invisible line
Versions 16 and later
Only the value 0 (solid line) and the value 5 (invisible line) are supported in browser code.
New in version 16
Only the value 0 (solid line) and the value 5 (invisible line) are supported in browser code.
Only the value 0 (solid line) and the value 5 (invisible line) are supported in browser code.

<Line thickness>: Optional integer

Thickness of the line in pixels (1 by default).

<Opacity>: Optional integer

Opacity of color, included between 0 (transparent) and 255 (opaque). An opacity set to 128 is used to blend 50% of the color with the existing color found in the control.
Remarks:
This opacity will be taken into account if the drawing in the Image control has been initialized with the constant dWithOpacity (function dStartDrawing).
Versions 23 and later
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.
New in version 23
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.

Remarks

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.
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. The dStartDrawing function becomes unnecessary. 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. The dStartDrawing function becomes unnecessary. 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.

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