y

Détermine la coordonnée y d’un objet de conception de formulaire donné par rapport à son objet parent.

Syntaxe

Reference_Syntax.y( OBJECT param1 [, STRING param2 [, INTEGER param3 ] ] )

Paramètres

param1

L’expression de syntaxe de référence complète d’un des objets de formulaire suivant : area, contentArea, draw, field, pageArea, subform.

param2 (facultatif)

Chaîne représentant le type d’unité de la valeur renvoyée. Si le paramètre est vide, le type d’unité par défaut est points.

param3 (facultatif)

Entier représentant une valeur d’index de base zéro indiquant la zone de contenu dans laquelle vous souhaitez obtenir la coordonnée y de l’objet. Si aucune valeur n’est définie, la valeur par défaut est 0.

Ce paramètre permet de calculer la coordonnée y d’un objet distribué dans plusieurs zones de contenu, telles que des pages. Par exemple, si vous souhaitez trouver la coordonnée y absolue d’un objet de sous-formulaire qui s’étend sur plusieurs zones de contenu, vous pouvez utiliser ce paramètre pour calculer la coordonnée y absolue du sous-formulaire dans chacune des zones de contenu et additionner les totaux.

Si l’objet pour lequel vous souhaitez calculer une coordonnée y est imbriqué dans plusieurs couches d’objets parents, vous devez prendre en compte la coordonnée y de chaque objet parent lors du calcul de la coordonnée y réelle de l’objet.

Renvoie

Coordonnée y de l’objet de conception de formulaire sous la forme d’un double.

Application

Version

XFA 2.1

Exemples

JavaScript

// Returns the y coordinate of a single instance of TextField1, relative to 
// its parent object. 
xfa.layout.y(TextField1,"in"); 
 
// Calculates the y coordinate of Subform1 across two content areas and 
// displays the total in a message box. 
var iY = xfa.layout.y(Subform1,"in",0) + xfa.layout.y(Subform1,"in",1); 
xfa.host.messageBox(iY);

FormCalc

// Returns the y coordinate of a single instance of TextField1, relative to 
// its parent object. 
xfa.layout.y(TextField1,"in") 
 
// Calculates the y coordinate of Subform1 across two content areas and 
// displays the total in a message box. 
var iY = xfa.layout.y(Subform1,"in",0) + xfa.layout.y(Subform1,"in",1) 
xfa.host.messageBox(iY)