カーソルはFormEditorで指定した印刷データを表すオブジェクトです。カーソルオブジェクトはPrintStreamスクリプトの開始時点でオープンされ、１件目のレコードに位置付けられています。このカーソルは印刷データの種類や形式に関係なく、同じように利用できます。
カーソルはODBCデータベースやファイルに対応している場合でも、常に読み込み専用です。データベースの更新や、データを削除することはできません。
|
メソッド |
説明 |
|---|---|
|
カーソルからデータを取得 |
|
|
カーソルにデータを設定 |
|
|
次のデータにカーソルを設定 |
|
|
カーソルの終了を取得 |
|
|
グループレベル取得のための準備 |
|
|
集計フィールドの計算 |
|
|
印刷データのレコード件数を取得 |
|
|
カーソルの現在の状態を保存 |
|
|
カーソルを復元 |
|
プロパティ |
説明 |
|---|---|
|
印刷データのグループレベルを取得 |
|
|
グループの改ページ情報を取得 |
|
説明 |
データ項目名を指定し、カーソルオブジェクトから印刷データを文字列で取得します。数値で取得するためには下記のように型変換を行います。 numData = Number(cursor.GetValue( "Item1" )) |
||
|---|---|---|---|
|
呼出形式 |
String = cursor.GetValue( itemname ); |
||
|
引数 |
|
||
|
戻り値 |
正常終了：印刷データ エラー終了：メッセージを表示し、処理を中断。 |
|
説明 |
データ項目名を指定し、カーソルオブジェクトに印刷データを設定します。このメソッドはメモリ上に読み込まれているデータを更新します。データベースやファイルに格納されているデータを書き換えることはありません。 |
||||
|---|---|---|---|---|---|
|
呼出形式 |
cursor.SetValue( itemname, value ); |
||||
|
引数 |
|
||||
|
戻り値 |
正常終了：なし エラー終了：メッセージを表示し、処理を中断。 |
|
説明 |
次のデータにカーソルを設定します。 |
|---|---|
|
呼出形式 |
bool = cursor.MoveNext( ); |
|
引数 |
なし |
|
戻り値 |
正常終了：0 印刷データの終端：1 |
|
説明 |
カーソルオブジェクトの印刷データが終わりかどうか調べます。 |
|---|---|
|
呼出形式 |
bool = cursor.IsEod( ); |
|
引数 |
なし |
|
戻り値 |
印刷データの途中：0 印刷データの終端：1 |
|
説明 |
フォームファイルで設定したグループに基づき、キーブレイク判定を行います。このメソッドは、OnFormLoadイベントハンドラ内でカーソルループを使用する場合にCalculateTotal()関数と共に使います。 PrepareKeyBreakの実行により以下の機能が有効となります。 ・keyBreakLevelプロパティ ・pageBreakプロパティ ・前の行と同じデータは印刷しない設定 ・グループ指定の合計、件数、連番の算出 また、印刷データのグループで改ページ指定が設定されている場合、必ずPrepareKeyBreak()関数を呼び出してください。 |
|---|---|
|
呼出形式 |
cursor.PrepareKeyBreak( ); |
|
引数 |
なし |
|
戻り値 |
なし |
|
説明 |
フォームファイルの指定に基づき集計を行います。このメソッドは、OnFormLoadイベントハンドラ内でカーソルループを使用する場合にPrepareKeyBreak()関数と共に使います。 |
|---|---|
|
呼出形式 |
cursor.CalculateTotal( ); |
|
引数 |
なし |
|
戻り値 |
なし |
|
説明 |
印刷データのレコード件数を取得します。levelに0を指定すると、全体のレコード件数を取得します。levelにキーブレイクレベルを指定すると、現在カーソルが指している場所のグループのレコード件数が取得できます。引数を省略すると、全体のレコード件数を取得します。 この関数は、レコードを先読みして件数を計算します。そのため、データ件数が大量にある場合に呼び出すと、全体の動作が遅くなる可能性があります。 |
||
|---|---|---|---|
|
呼出形式 |
Number = cursor.GetRecordCount( ); Number = cursor.GetRecordCount( level ); |
||
|
引数 |
|
||
|
戻り値 |
正常終了：レコード件数 エラー終了：-1 |
||
|
バージョン |
3.0以降 |
|
説明 |
カーソルの現在の状態を保存します。カーソルを復元するにはRestoreCursor()関数を使用します。これらを使用することにより、カーソルを戻すことや、データの先読みを実現できます。 |
|---|---|
|
呼出形式 |
cursor.SaveCursor( ); |
|
引数 |
なし |
|
戻り値 |
なし |
|
バージョン |
3.0以降 |
|
説明 |
カーソルの状態を以前のSaveCursor()関数で保存した状態に復元します。 |
|---|---|
|
呼出形式 |
cursor.RestoreCursor( ); |
|
引数 |
なし |
|
戻り値 |
なし |
|
バージョン |
3.0以降 |
|
説明 |
直前のPrepareKeyBreak()関数の呼び出しによりキーブレイクと判断されたグループレベルを示します。 PrepareKeyBreak()関数の後に参照できます。 |
|---|---|
|
型 |
Number （読出し専用） |
|
使用形式 |
Number = cursor.keyBreakLevel; |
|
説明 |
直前のPrepareKeyBreak()関数の呼び出しにより改ページ付きのキーブレイクと判断されたかどうかを示します。 PrepareKeyBreak()関数の後に参照できます。 |
|---|---|
|
型 |
Number (読出し専用) |
|
使用形式 |
Number = cursor.pageBreak; |
|
設定値 |
1:改ページ 0:改ページではない |