dTextRTF (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

Related examples

See also

dTextRTF (Function)

In french: dTexteRTF

Draws an RTF text:

in an Image control,
in an Image variable.
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 an picLayer variable.
New in version 25
in an picLayer variable.
in an picLayer variable.

Example

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

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

Versions 24 and later

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

New in version 24

// Draw an 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

Versions 24 and later
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. 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.
the name of an Image variable.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. 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.
the name of an Image variable.
Versions 25 and later
the name of an WDPic variable. Only the background layer will be handled.
New in version 25
the name of an WDPic variable. Only the background layer will be handled.
the name of an WDPic variable. 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.

<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 (with quotes)

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

The coordinates are given in relation to the top left corner of the image or Image control ((0, 0) coordinates).

The coordinates correspond to the top 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.
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.

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.

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.

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