<Image variable>.DrawText (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Font
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 Variable of type Image.

Versions 25 and later

This function is now available for Android applications.

This function is now available for Java applications.

New in version 25

This function is now available for Android applications.

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available for Java applications.

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. For more details, see The drawings.

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. For more details, see The drawings.

This function is now available for WEBDEV sites in Linux.

Caution: A specific configuration is required to use this function in Linux. For more details, see The drawings.

Versions 16 and later

This function is now available for Android applications.

New in version 16

This function is now available for Android applications.

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.

Example

MyImage is Image = "Test.gif"
// Draw a text in light yellow
MyImage.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 string (without formatting marks such as TAB, CR, etc.),
a numeric.

<Text color>: Integer or constant (optional)

Text color to use. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
une preset color of WLanguage.
If this parameter is not specified, the color of the text:
is Black if the <Image variable>.Pen function has not been used before,
corresponds to the Color specified in the last call to function <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.

The default font may differ according to the system on which the application is run.

Coordinates

Coordinates are given with respect to the top left corner of the image (coordinates: (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 function) or in opacity mode (<Image variable>.StartDrawing function), the <Image variable>.DrawText function is only available for TrueType.

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