<Image variable>.DrawText (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

New WINDEV, WEBDEV, WINDEV Mobile 24 feature!

Font
Background color
Coordinates
Management of '&'
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Image variable>.DrawText (Function)

In french: <Variable Image>.DessineTexte

Draws a text in an Image variable.

Example

MyImage is Image = "Test.gif"
// Draw a text in light yellow
IMG_Drawing.DrawText(10, 20, "Easy development", LightYellow)
IMG_MyDrawing = MyImage

Syntax

<Image variable>.DrawText(<X coordinate> , <Y coordinate> , <Text> [, <Text color> [, <Management of &>]])

<Image variable>: Image variable

Name of Image variable to use.

<X coordinate>: Integer

X coordinate of text to draw (in pixels).

<Y coordinate>: Integer

Y coordinate of text to draw (in pixels).

<Text>: Type corresponding to the text to draw

Text to draw. This text can be:
a character string (without control characters such as TAB, CR, etc.),
a numeric value.

<Text color>: Integer or constant (optional)

Text color to use. This color corresponds to:
an RGB color (returned by RGB).
an HSL color (returned by HSL).
a preset color of WLanguage.
If this parameter is not specified, the color of the text:
is Black if <Image variable>.Pen was not used beforehand,
corresponds to the color specified in the last call to <Image variable>.Pen.

<Management of &>: Optional boolean

True (default value) if the "&" character must not be interpreted as an underline operator.
False if the "&" character must be interpreted as an underline operator: the character following the "&" character will be underlined.

Remarks

Font

By default:

The font used is "MS Sans Serif" (size 13).
The writing direction is horizontal (from left to right).
The coordinates of the top left corner of the image are (0,0).
The "&" character is not interpreted.

To modify these parameters, use <Image variable>.Font.

Background color

By default, the background color of an Image control is transparent. To modify the background color of an Image control, use ..BackgroundColor.

Coordinates

The coordinates are specified in relation to the top left corner of the Image control (coordinates set to (0,0)).

The coordinates correspond to the top left corner of the rectangle into which the text will be drawn. The precise location of the text in this rectangle depends on the size, shape and attributes of the font.

Management of '&'

The parameter <Management of & > makes it possible to manage the use of the '&' character.
Example:

the "&" character must not be interpreted as an underline operator. For example:

MyImage.DrawText(10, 10, "Tom&Jerry", LightRed, True)

will display "Tom&Jerry".
the "&" character must be interpreted as an underline operator: the character following the "&" character will be underlined. For example:

MyImage.DrawText(10, 10, "&Edit", LightRed, False)

will display "Edit".

Limitations

In anti-aliasing mode (<Image variable>.ChangeMode) or in opacity mode (<Image variable>.StartDrawing), <Image variable>.DrawText is available only for True Type fonts.

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

Component : wd240pnt.dll