FORM GET PROPERTIES
FORM GET PROPERTIES ( {aTable ;} formName ; width ; height {; numPages {; fixedWidth {; fixedHeight {; title}}}} )
| 引数 | 型 | 説明 | |
|---|---|---|---|
| aTable | Table | → | フォームが属するテーブル、省略時はデフォルトテーブル |
| formName | Text | → | フォーム名 |
| width | Integer | ← | フォームの幅 (ピクセル) |
| height | Integer | ← | フォームの高さ (ピクセル) |
| numPages | Integer | ← | フォームのページ数 |
| fixedWidth | Boolean | ← | True = 幅固定, False = 幅可変 |
| fixedHeight | Boolean | ← | True = 高さ固定, False = 高さ可変 |
| title | Text | ← | フォームのウィンドウタイトル |
このコマンドはスレッドセーフではないため、プリエンプティブなコードには使えません。
説明
FORM GET PROPERTIES コマンドはformNameフォームのプロパティを返します。
widthおよびheight引数は、フォームの幅と高さをピクセル単位で返します。これはフォームプロパティのデフォルトウインドウサイズプロパティの値です:
- フォームサイズが自動サイズの場合、幅と高さは縦横マージンを考慮に入れ、フォーム内の全オブジェクトが表示可能となるように計算されます。
- フォームサイズがサイズ設定の場合、幅と高さはプロパティに入力されたものになります。
- フォームサイズがオブジェクトを起点にするよう指定されている場合、幅と高さはこのオブジェクトの位置を元に計算されます。
numPages 引数0ページを除いたフォーム内のページ数を返します。
fixedWidth と fixedHeightには、フォームの幅と高さがサイズ変更可であるか (False) 、固定に設定されているか (True) を返します。
title 引数には、フォームエディターのプロパティリスト内で定義されているフォームのウインドウタイトルを返します。名前が定義されていないとtitle引数に空文字を返します。