フォームオブジェクト

 

このオブジェクトはフォームファイルを示します。フォームファイルに定義される情報は、すべてこのオブジェクトを基点にして取得、設定を行います。

 

メソッド

説明

GetParameter

実行パラメータを取得

GetPage

ページオブジェクトを取得

GetCursor

カーソルオブジェクトを取得

End

カーソルを閉じ、スクリプトから復帰

SetWaitMode

レコード出力タイミングの設定

WriteRecords

蓄積されたレコードの一括出力

GetWaitRecord

蓄積されたレコードの取得

 

プロパティ

説明

name

フォームファイル名を取得

type

オブジェクトタイププロパティ

 

GetParameter

 

説明

FormEditorで設定した実行パラメータを取得します。

呼出形式

String = qfm.GetParameter( symbol );

引数

String symbol

取得する実行パラメータのシンボルを指定します。

戻り値

正常終了:実行パラメータ

エラー終了:空の文字列。未設定の場合も同じ。

 

GetPage

 

説明

ページ情報を持つページオブジェクトを作成します。複合フォーム使用時は、引数を指定することにより特定のフォームをページオブジェクトとして取得することができます。また、複合フォーム使用時に引数を省略した場合は、現在のフォームを取得します。

呼出形式

page = qfm.GetPage( );

page = qfm.GetPage( name );

page = qfm.GetPage( index );

引数

String name

取得するフォームの名前

Number index

取得するフォームのインデックス(デザイン画面の左を0番目から数える)

戻り値

正常終了:ページオブジェクト

エラー終了:メッセージを表示し、処理を中断。

バージョン

引数name、indexは3.0以降

 

GetCursor

 

説明

FormEditorで設定した印刷データに対応するカーソルオブジェクトを返します。フォームに印刷データが定義されていない場合、エラーとなります。

呼出形式

cursor = qfm.GetCursor( );

引数

なし

戻り値

正常終了:カーソルオブジェクト

エラー終了:メッセージを表示し、処理を中断。

 

End

 

説明

印刷処理の終了を通知します。カーソルは閉じられ、スクリプトから復帰したあと、既定の動作を継続せずに終了します。

呼出形式

qfm.End( );

引数

なし

戻り値

正常終了:なし

エラー終了:メッセージを表示し、処理を中断。

 

SetWaitMode

 

説明

レコードオブジェクトのWrite()関数の出力タイミングを設定します。trueを設定した場合、Write()関数が呼び出された時点では実際に出力せず、バッファに蓄積します。WriteRecords()関数を呼び出すことにより、蓄積されたレコードは一斉に出力されます。

改ページのタイミングを厳密に操作したい場合などに利用します。

呼出形式

qfm.SetWaitMode( mode );

引数

bool mode

true:Write()関数が即時出力されずに待機します。

false:Write()関数は即時出力されます。(デフォルト)

引数を省略するとtrueが設定されます。

戻り値

なし

バージョン

3.0以降

 

WriteRecords

 

説明

SetWaitMode()関数でtrueを設定した場合に、レコードオブジェクトのWrite()関数によって蓄積されたレコードを一斉に出力します。

改ページが発生した場合は引数numをOnPageChangeイベントハンドラの引数に渡すことができます。これにより、OnPageChangeイベントハンドラでは改ページの発生理由を知ることができます。

呼出形式

qfm.WriteRecords( );

qfm.WriteRecords( num );

引数

Number num

OnPageChange()イベントハンドラに渡すデータ

戻り値

なし

バージョン

3.0以降

 

GetWaitRecord

 

説明

SetWaitMode()関数でtrueを設定した場合に、レコードオブジェクトのWrite()関数によって蓄積されているindex番目レコードを取り出します。

引数を省略すると次のレコードを取り出します。

レコードが無くなるとnullを返します

呼出形式

record = qfm.GetWaitRecord( index );

引数

Number index

取得するレコードの番号

戻り値

レコードオブジェクト

バージョン

3.0以降

 

name

 

説明

フォームファイル名を取得します。プレビュー時はプレビュー用に作成された一時的なファイル名が返されます。

String (読出し専用)

使用形式

String = qfm.name;

 

type

 

説明

"qfm"を返します。

String (読出し専用)

使用形式

String = qfm.type;

 



「オンラインマニュアル」一覧へ戻る
「Bizの宝箱」TOPへ戻る