帳票の出力時に使用する帳票と入力データを保持するクラスです。
Formsクラスは、入力データを行単位で扱う場合に使用します。
fujitsu.listcreator.FormBase
└─fujitsu.listcreator.Forms
public class Forms : FormBaseFormsクラスのコンストラクタを以下に示します。
コンストラクタの概要 | |
|---|---|
帳票名と帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsオブジェクトを生成します。 | |
Forms(string formname, string assets, string cbformname) (*1) | |
帳票名、帳票格納ディレクトリ、および組合せフォーム名を指定して、帳票と帳票データの セットを保持するFormsオブジェクトを生成します。 | |
*1：
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。
⇒ “5.6 注意事項”
Formsクラスのプロパティを以下に示します。
プロパティの分類 | プロパティ名（プロパティの設定内容） | データ型 |
|---|---|---|
string | ||
string | ||
string | ||
int |
Formsクラスのメソッドを以下に示します。
メソッドの分類 | メソッド一覧 | ||
|---|---|---|---|
void | |||
帳票を出力するための入力データとなるレコード（行）文字列を追加します。 | |||
|
用途
帳票名と帳票格納ディレクトリ、を指定して、帳票と入力データのセットを保持するFormsオブジェクトを生成します。
パラメータ
帳票属性の編集コマンド（lmedtformatrコマンド）で定義した帳票名を指定します。
マルチフォーム出力する場合は、1番目に出力する帳票の帳票名を指定します。
帳票管理サーバでユーザアプリケーションを実行する場合は、帳票管理サーバの帳票格納ディレクトリをフルパスで指定します。省略すると、帳票管理サーバの環境設定ファイルのLmlcFormDirキーの指定が有効になります。
List Creatorコネクタ連携時は、アプリケーションサーバの帳票格納ディレクトリをフルパスで指定します。省略した場合、List Creator Connectorの環境設定で指定した帳票格納ディレクトリが有効となります。List Creator Connectorの環境設定については、List Creator Connectorに添付のオンラインマニュアルを参照してください。
例外
PrintException
|
用途
帳票名、帳票格納ディレクトリおよび組合せフォーム名を指定して、帳票と帳票データのセットを保持するFormsオブジェクトを生成します。
ここで指定した帳票名と組合せフォーム名は、ChangeForm プロパティやChangeCbForm プロパティで切り替えるまでの間、指定されたデータの組合せフォーム、および指定されたデータの帳票として使用します。
パラメータ
帳票名を指定します。
一番目に出力する帳票名を指定します。
帳票格納ディレクトリをフルパスで指定します。
組合せフォーム名を指定します。
例外
PrintException
注意
コンストラクタ共通
帳票定義情報の配置場所と指定方法については、以下を参照してください。
⇒“付録A 帳票資源の指定方法”
帳票格納ディレクトリ名の末尾には、「円マーク（\）」を指定しないでください。
帳票名または帳票格納ディレクトリに、全角文字および半角カナ文字は指定できません。
指定できる文字については、以下を参照してください。
⇒“第8章 List Manager帳票出力インタフェースで指定できる文字”
また、List Creatorコネクタ連携時、アプリケーションサーバから帳票管理サーバにファイルを転送するときに指定可能なパス長については、以下を参照してください。
⇒“5.6.2 List Creatorコネクタ連携時の注意事項”
帳票管理サーバがWindowsの場合、帳票格納ディレクトリとして、ネットワークドライブ（UNC 指定（¥¥コンピュータ名¥共有名¥ディレクトリ名）を除く）、およびリムーバブルディスクを指定しないでください。
List Creatorコネクタ連携時、アプリケーションサーバのファイルの格納先として指定できるのは、ローカルディスクのみです。ネットワークドライブ、UNC指定（\\コンピュータ名\共有名\ディレクトリ名）、またはリムーバブルディスクを格納先として指定しないでください。
ポイント
コンストラクタ共通
帳票出力サーバに帳票定義情報を配置した場合、このコンストラクタで帳票格納ディレクトリを指定しないでください。指定しない場合、帳票出力サーバの環境設定ファイルのLmlcFormDir キーで指定した帳票格納ディレクトリの指定が有効になります。
List Creatorコネクタ連携時、帳票管理サーバに帳票定義情報を配置する場合は、帳票管理サーバの帳票格納ディレクトリをPrintPropertiesクラスのRemoteDirectoryプロパティで指定してください。
RemoteDirectoryプロパティを指定しない場合は、帳票管理サーバの環境設定ファイルのLmlcFormDirキーの指定が有効となります。
マルチフォーム出力する場合、使用する帳票をChangeFormプロパティで切り替えてください。このコンストラクタで指定した帳票名は、ChangeFormプロパティで帳票を切り替えるまで有効となります。
マルチフォーム出力する場合、このコンストラクタで指定した帳票名の以下の情報がすべての帳票に対して有効となります。
帳票属性の編集コマンド（lmedtformatrコマンド）で指定する帳票属性に関する情報
プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定するプリンタ構成に関する情報
List Creatorデザイナで指定した帳票出力に関する情報
ただし、指定方法によっては、帳票ごとに切り替えることが可能な情報があります。マルチフォーム出力時の留意事項については、以下を参照してください。
⇒List Creatorに添付のオンラインマニュアル“帳票設計編”
組合せフォーム出力する場合は、Forms(string formname, string assets, string cbformname) コンストラクタを使用してください。
●帳票切り替えに関するプロパティ
●組合せフォーム出力に関するプロパティ
複数の組合せフォーム出力する場合に、使用する組合せフォーム名を切り替えます。
このプロパティ設定以降にpushRecord メソッドで指定した入力データは、この組合せフォームの入力データとなります。
注意
複数の組合せフォームを出力する場合は、使用する組合せフォーム名をこのプロパティで切り替えてください。
また、ChangeForm プロパティで使用する帳票を切り替えてから、pushRecordメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。
組合せフォーム定義ファイル名をフルパスで指定します。
組合せフォーム定義ファイルとは、組み合わせて出力する帳票定義情報と、帳票定義情報の重なり順などが定義されたファイルです。
注意
組合せフォーム定義ファイルの文字コード系については、List Creatorに添付のオンラインマニュアル“帳票設計編” を参照してください。
コネクタ連携時に、アプリケーションサーバから組合せフォーム定義ファイルを転送した場合、組合せフォーム定義ファイルは、このプロパティとPrintPropetitsクラスのLcFile プロパティの両方で指定してください。その場合、このプロパティには、ファイル名のみ指定してください。
●ユーザ資源情報に関するプロパティ
●レコード（行）出力に関するメソッド
用途
帳票を出力するための入力データとなるレコード（行）文字列を追加します。
パラメータ
レコード（行）文字列を指定します。
例外
PrintException
注意
1レコード（行）ずつレコード（行）文字列をセットしてください。
レコード（行）文字列には改行コードを含めないでください。
帳票出力時の文字コードを指定する場合、このメソッド指定前にDataCodeプロパティで文字コードを指定してください。
マルチフォーム出力/組合せフォーム出力する場合は、使用する帳票をChangeFormプロパティで切り替えてから、このメソッドで帳票名を含めずにレコード（行）文字列を指定してください。
複数の組合せフォームを出力する場合は、使用する組合せフォーム名をChangeCbForm プロパティで切り替えてから、このメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。
文字コード系に関しては、以下を参照してください。
⇒“C.3 .NETインタフェース使用時の文字コード系”
List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
⇒“付録D 文字 コード系に関する注意事項（List Creatorコネクタ連携時）”
帳票の入力データ形式が「XML形式」の場合は、このクラスを使用して帳票出力できません。FormsFileクラスを使用してください。