y

親オブジェクトを基準とする、指定したフォームデザインオブジェクトの Y 座標を判定します。

構文

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

パラメーター

param1

area、contentArea、draw、field、pageArea、subform のいずれかの XML フォームオブジェクトモデルのオブジェクトの完全修飾参照構文式です。

param2（オプション）

戻り値の単位のタイプを表す文字列です。空白の場合、デフォルトの単位のタイプはポイントです。

param3（オプション）

オブジェクトの Y 座標を取得するコンテンツ領域を示すゼロベースのインデックス値を表す整数値です。空白の場合、デフォルトの値は 0 です。

このパラメーターを使用すると、ページなど複数のコンテンツ領域に分散するオブジェクトの Y 座標を計算できます。例えば、複数のコンテンツ領域にまたがるサブフォームオブジェクトの Y 座標の絶対配置を確認する場合は、このパラメーターを使用して各コンテンツ領域のサブフォームの Y 座標を列挙してすべて合計します。

Y 座標を計算するオブジェクトが親オブジェクトの複数のレイヤー内にネストされている場合は、オブジェクトの実際の Y 座標を計算するときに各親オブジェクトの Y 座標を計算に入れる必要があります。

戻り値

フォームデザインオブジェクトの可変の Y 座標です。

適用先

モデル	オブジェクト
レイアウトモデル	layoutPseudoModel

バージョン

XFA 2.1

例

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)