カスタムコントロール「PrctrlEx Control」には、以下のメソッドがあります。なお、異常が発生した場合、エラーは、環境設定画面の指定にしたがって、メッセージボックスまたはイベントログに通知されます。
メソッド名 | 引数 | 復帰値 | |||
|---|---|---|---|---|---|
帳票出力の実行 | PrintOut | なし | Long | 0：正常終了 | |
プレビューの実行 | View | なし | Long | 0：正常終了 | |
総ページ数のカウント | PageCount | なし | Long | 正の整数：ページ数 | |
データファイルの生成 | データファイル生成 | StartData | なし | Integer | 0：正常終了 |
データファイルにデータ出力 | DataWrite | 文字列 | Integer | 0：正常終了 | |
データファイル生成 | StopData | なし | Integer | 0：正常終了 | |
データファイル生成 | EndData | なし | Integer | 0：正常終了 | |
*1：
JobWaitプロパティに「TRUE」を指定し、帳票の出力完了を待ち合わせているときに異常が発生した場合に、-101～-108で復帰します。
復帰値 | 意味 |
|---|---|
-101 | スプールドキュメントが削除されました。 |
-102 | スプールドキュメントが保留されました。 |
-103 | 出力装置がオフライン、またはストップ状態のため、帳票を出力することができませんでした。 |
-104 | 出力装置が用紙切れのため、帳票を出力することができませんでした。 |
-105 | 出力装置がエラー状態のため、帳票を出力することができませんでした。 |
-106 | リモート出力装置へスプールドキュメントを転送中にエラーが発生しました。 |
-107 | 出力後保存中にエラーが発生しました。 |
-108 | 用紙交換メッセージ、または出力開始メッセージ応答待ち状態のため、出力完了待ち合わせが解除されました。 |
設定された各プロパティにしたがって帳票出力を実行します。
以下に、メソッドの呼び出し例を示します。
PrctrlEx1.PrintOut() |
設定された各プロパティにしたがってプレビューを実行します。
以下に、メソッドの呼び出し例を示します。
PrctrlEx1.View() |
設定された各プロパティにしたがって総ページ数をカウントします。
以下に、メソッドの呼び出し例を示します。
PrctrlEx1.PageCount() |
DataFileプロパティに指定するデータファイルをプログラム中で動的に生成します。
まず、StartDataメソッドを引数なしで呼び出します。
次に、DataWriteメソッドを呼び出し、データをセットしていきます。この時、データの形式は、1レコード（行）を1回の単位とします。
データを渡し終えた時点でEndDataメソッドを呼び出します。
データファイルの生成処理を中断する場合は、StopDataメソッドを呼び出します。この場合、EndDataメソッドを呼び出す必要はありません。
ポイント
StartData/DataWrite/EndDataメソッドを呼び出して動的にデータファイルを生成した場合、アプリケーションでは、DataFileプロパティを指定する必要はありません。DataFileプロパティを指定しても、無効となります。
StartDataメソッド を呼び出した場合は、必ずEndDataメソッドを呼び出してください。
動的に生成したデータファイルは、カスタムコントロール「PrctrlEx Control」が破棄されるときに自動的に削除されます。
DataWriteメソッドの引数で指定するデータファイル（入力データ）の指定形式、および注意事項については、オンラインマニュアル“帳票設計編”を参照してください。
DataWriteメソッドでは、Shift-JISの文字列データを指定してください。
Unicodeの文字が定義されている帳票定義情報を使用する場合、StartData/DataWrite/EndDataメソッドを使用して帳票出力することはできません。
英語環境（英語ロケール）でStartData/DataWrite/EndDataメソッドを使用して帳票出力することはできません。
以下に、メソッドの呼び出し例を示します。
PrctrlEx1.StartData() |
