dTextRTF (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Drawing functions

Coordinates
Using the drawing functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

dTextRTF (Function)

In french: dTexteRTF

Draws RTF text:

in an Image control,
in a variable of type Image.
in a variable of type WDPic (on the background layer),
in a variable of type picLayer.

Example

// Initialize the drawing in an Image control
dStartDrawing(IMG_Drawing)
// Draw RTF text
dTextRTF(10, 20, MyRTFText)

// Draw RTF text
dTextRTF(IMG_Drawing, 10, 20, MyRTFText)

Syntax

dTextRTF([<Image>, ] <X-coordinate> , <Y-coordinate> , <RTF text> [, <Width> [, <Height>]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Image to use. The image can correspond to:
the name of an Image control.
the name of a variable of type Image.
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type picLayer.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<X-coordinate>: Integer

X-coordinate of the RTF text to draw (in pixels).

<Y-coordinate>: Integer

Y-coordinate of the RTF text to draw (in pixels).

<RTF text>: Character string

RTF text to draw.

<Width>: Optional integer

Maximum width of the text. No maximum width is defined by default.

<Height>: Optional integer

Maximum height of the text. No maximum height is defined by default.

Remarks

Coordinates

Coordinates are specified with respect to the upper-left corner of the image or Image control (coordinates: (0,0)).

The coordinates correspond to the upper-left corner of the rectangle into which the text will be drawn.

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

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