iAreaHeight (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Print functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

iAreaHeight (Function)

In french: iHauteurZone

Warning
From version 28, iZoneHeight is kept for backward compatibility. This function has been replaced with iAreaHeight.

Calculates the height of a fixed-width area required to print the entire text that uses the current font.

Remark: This function must not be used in the "Open" event of the report.

Example

See additional examples

// Selects a font
iFont(FontNum)
// Retrieves the height of the column
dHeight is real = iAreaHeight("My Text", 100)
// Draws a border
iBorder(0, 0, dHeight*2, 200)

Syntax

<Result> = iAreaHeight(<Text> , <Area width> [, <Type> [, <Beginning> [, <End>]]])

<Result>: Real

Height of the area (in millimeters) allowing to entire text to be printed.

<Text>: Character string

Text to print. This text can be in RTF or HTML. This string must be encoded using UTF-8. If necessary, use StringToUTF8 to perform the conversion.

<Area width>: Real

Width of area (in millimeters).

<Type>: Optional constant

Type of text to print:
iHTML Text in HTML format.
This constant is not available.
iMarkdown Markdown text.
This constant is not available.
This constant is available only for reports. For print jobs set programmatically, this constant is not available.
iRTF Text in RTF.
This constant is not available.
iText
(default value) Normal text.

This parameter will be ignored. The text is always of normal type.

<Beginning>: Optional integer

Index of the first <Text> character to print. If this parameter is not specified, the first character of the string is used.

<End>: Optional integer

Index of the last <Text> character to print. If this parameter is not specified, the last character of the string is used.

Business / UI classification: Neutral code

Component: wd300prn.dll