iYPos (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

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

Origin and physical margins
Managing the parameter
Combining positions
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

iYPos (Function)

In french: iPosY

Controls the vertical position (ordinate or line) of the print cursor on the page. You can:

find out the current vertical position,
modify the vertical position of print cursor.

Note When printing a text string, the current vertical position points to the top of the string to be printed. The bottom print line depends on the height of the fonts used in the printed line.

Example

// Traçage de traits horizontaux tous les deux millimètres
// sur toute la hauteur de la page
iHLine(0, iPageWidth(), 1)  // Trace un trait
iYPos(iYPos() + 2)  // Positionne le curseur 2 mm plus bas
iHLine(0, iPageWidth(), 3)  // Trace un second trait
iEndPrinting()

Syntax

Finding out the vertical position of print cursor Hide the details

<Result> = iYPos()

<Result>: Real

Current vertical position of cursor (in millimeters).

Modifying the vertical position of print cursor Hide the details

<Result> = iYPos(<Vertical position> [, <Immediate calculation>])

<Result>: Character string

Requested vertical position.

<Vertical position>: Real

New vertical position (Y-coordinate) of print cursor (in millimeters).

<Immediate calculation>: Optional boolean

True (by default) to immediately calculate the vertical position.
False if the vertical position must be calculated during the print (when nesting positions for example). For more details, see remarks.

Remarks

Origin and physical margins

The origin (0,0) is located in the upper-left corner of the sheet. This origin takes the physical printer margins into account.

Each printer includes physical margins in which no printing is possible. iMargin is used to define the "logical" print margins. If logical margins have been defined, iYPos manages the vertical position according to these new margins.

Managing the <Immediate Calculation> parameter

When <Vertical Position> is specified in iYPos, the function performs two actions at the same time:

Returns a control character string. This control character string modifies the print position when the string is printed.
Immediately modifies the position of print cursor

The <Immediate Calculation> parameter is used to retrieve the control character string without modifying the current position of print cursor

sMonTitre is string = "Titre impression" 
iDestination(iViewer)

// --- CAS 1 : <Calcul immédiat> à Vrai (par défaut)
// Positionnement du curseur à l'endroit souhaité
// Note : La chaîne de caractères de contrôle n'est pas récupérée ici
iXPos((iPageWidth() - iTextWidth(sMonTitre))/2) 
// Calcul pour centrer le texte
// Impression à la position du curseur précédemment déterminée
iPrint(sMonTitre) 	// Donc doit être centré

// --- CAS 2 : Le même code avec le paramètre <Calcul immédiat> à Faux
// La chaîne de caractères de contrôle n'est pas récupérée ici
// Et le curseur d'impression n'est pas positionné car 
// <Calcul immédiat> est à Faux
// Note : Donc cette ligne ne sert à rien
iXPos((iPageWidth() - iTextWidth(sMonTitre))/2, False)
// Impression à la position du curseur. 
// La ligne de code précédente ne l'ayant pas changé, le texte va s'imprimer 
// à la position précédente (donc en début de ligne ici)
iPrint(sMonTitre)	// Donc NE doit PAS être centré

// --- CAS 3 : Le code en une seule ligne
// Avec le paramètre <Calcul immédiat> à Faux ou à Vrai, 
// le résultat est le même
// La position du curseur d'impression est modifiée au moment de 
// l'exécution de iPosX, et au moment de l'impression de la 
// chaîne de caractères qui contient le résultat renvoyé par iPosX
iPrint(iXPos((iPageWidth() - iTextWidth(sMonTitre))/2, True) + sMonTitre) 
// Donc doit être centré
// Le positionnement est fait deux fois : un peu plus lourd
// mais le résultat est celui attendu

// --- 3 Bis
// La position du curseur d'impression N'est PAS modifiée au moment
// de l'exécution de iPosX, MAIS elle est modifiée au moment
// de l'impression de la chaîne de caractères qui contient le résultat
// renvoyé par iPosX
iPrint(iXPos((iPageWidth() - iTextWidth(sMonTitre))/2, False) + sMonTitre) 
// Donc doit être centré

// Fin d'impression 
iEndPrinting()

Combining positions

When combining positions, unexpected results may occur. For example, the following code:

iYPos(50)
iPrint("Première partie" + iYPos(30) + "Seconde partie")

is not equivalent to:

iPrint(iYPos(50) + "Première partie" + iYPos(30) + "Seconde partie")

In the first case, the entire character string is printed at vertical position 30. In this case, the function iYPos(30) function is executed when the string to be printed is constructed, and therefore before the "First part" string is printed.

To obtain the same result, simply use (in the first syntax) the function iYPos with the parameter False parameter: the iPosY(30, False) function will only really be executed during printing.

The same operation can be performed by iXPos.

Miscellaneous

iYPos must not be used in a parameter of iPrintWord.

Component: wd300prn.dll