帳票の出力時に使用する帳票と入力データを保持するクラスです。
fujitsu.listcreator.FormBase
∟ fujitsu.listcreator.Forms
public class Forms : FormBaseFormsクラスのコンストラクタを以下に示します。
コンストラクタの概要 |
|---|
Forms(string formname, string assets)(*1) 帳票名と帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsを作成します。 |
Forms(string formname, string assets, string cbformname)(*1) 帳票名、帳票格納ディレクトリ、および組合せフォーム名を指定して、帳票と帳票データのセットを保持するFormsを作成します。 |
*1：
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。
Formsクラスのプロパティを以下に示します。
プロパティの分類 | プロパティ名（プロパティの設定内容） | データ型 |
|---|---|---|
string | ||
string | ||
string | ||
int |
Formsクラスのメソッドを以下に示します。
メソッドの分類 | メソッドの概要 | ||
|---|---|---|---|
共 | void | 帳票を出力するための入力データとなるレコード（行）文字列を追加します。 | |
W | void | XBRLデータ対応機能/Navigator連携機能を利用する場合に、帳票に配置する入力データの抽出条件となる固有情報を指定します。 | |
W | void | 帳票定義情報およびsetDataSourceメソッドの定義にしたがって入力データを抽出します。 | |
|
帳票名と帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsオブジェクトを生成します。
ここで指定した帳票名は、ChangeFormプロパティで帳票を切り替えるまでの間、指定されたデータの帳票として使用します。
帳票名を指定します。
マルチフォーム出力する場合は、一番目に出力する帳票の帳票名を指定します。
帳票格納ディレクトリをフルパスで指定します。
帳票格納ディレクトリは、アプリケーションサーバの帳票格納ディレクトリを指定してください。
PrintException
コネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintPropertiesクラスのRemoteDirectoryプロパティで指定してください。
帳票格納ディレクトリ名を指定する場合、以下の注意事項があります。
マルチフォーム出力する場合、使用する帳票をChangeFormプロパティで切り替えてください。
組合せフォーム出力する場合は、Forms(string formname, string assets, string cbformname) コンストラクタを使用してください。
|
帳票名と帳票格納ディレクトリ、および組合せフォーム名を指定して、帳票と帳票データのセットを保持するForms オブジェクトを生成します。
ここで指定した帳票名と組合せフォーム名は、ChangeFormプロパティやChangeCbFormプロパティで切り替えるまでの間、指定されたデータの組合せフォーム、および指定されたデータの帳票として使用します。
帳票名を指定します。
一番目に出力する帳票名を指定します。
帳票格納ディレクトリをフルパスで指定します。
組合せフォーム名を指定します。
PrintException
コネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintPropertiesクラスのRemoteDirectoryプロパティで指定してください。
組合せフォーム出力しない場合は、Forms(String formname, String assets) コンストラクタを使用してください。
マルチフォーム出力する場合、または組合せフォーム出力する場合、使用する帳票をChangeFormプロパティで切り替えてください。また、使用する組合せフォーム名を ChangeCbFormプロパティで切り替えてください。
マルチフォーム出力/組合せフォーム出力をする場合に、使用する帳票を切り替えます。このプロパティ以降にpushRecordメソッドで指定した入力データは、この帳票の入力データとなります。
注意
マルチフォーム出力、または組合せフォーム出力をする場合は、使用する帳票をこのプロパティで切り替えてから、pushRecordメソッドで帳票名や組合せフォーム名を含めずにレコード（行）文字列を指定してください。
複数の組合せフォーム出力する場合に、使用する組合せフォーム名を切り替えます。このプロパティ設定以降にpushRecord メソッドで指定した入力データは、この組合せフォームの入力データとなります。
注意
複数の組合せフォームを出力する場合は、使用する組合せフォーム名をこのプロパティで切り替えてください。
また、ChangeFormプロパティで使用する帳票を切り替えてから、pushRecordメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。
組合せフォーム定義ファイル名をフルパスで指定します。
組合せフォーム定義ファイルとは、組み合わせて出力する帳票定義情報と、帳票定義情報の重なり順などが定義されたファイルです。
このプロパティの呼び出しを省略すると、帳票格納ディレクトリ配下の組合せフォーム定義ファイル(Lccbform.ini）が有効になります。
注意
組合せフォーム定義ファイルの文字コード系については、オンラインマニュアル“帳票設計編”を参照してください。
コネクタ連携時に、アプリケーションサーバから組合せフォーム定義ファイルを転送した場合、組合せフォーム定義ファイルは、このプロパティとLcFileプロパティの両方で指定してください。その場合、このプロパティには、ファイル名のみ指定してください。
入力データの文字コードを指定します。
Shift-JIS
UNICODE（UTF8）
注意
このプロパティは、pushRecordメソッドを指定する前に指定してください。pushRecordメソッド指定後、このプロパティは指定できません。
Unicodeの文字が定義されている帳票定義情報を使用する場合、「CODE_UTF8」を指定してください。
英語環境（英語ロケール）で帳票出力する場合は、「CODE_UTF8」を指定してください。
|
帳票を出力するための入力データとなるレコード（行）文字列を追加します。
レコード（行）文字列を指定します。
1レコード（行）ずつレコード（行）文字列をセットしてください。
レコード（行）文字列には改行コードを含めないでください。
PrintException
マルチフォーム出力/組合せフォーム出力する場合は、使用する帳票をChangeFormプロパティで切り替えてから、このメソッドで帳票名を含めずにレコード（行）文字列を指定してください。
複数の組合せフォームを出力する場合は、使用する組合せフォーム名をChangeCbFormプロパティで切り替えてから、このメソッドで組合せフォーム名と帳票名を含めずにレコード（行）文字列を指定してください。
帳票出力時の文字コードを指定する場合、このメソッド指定前にDataCodeプロパティで文字コードを指定してください。
|
XBRLデータ対応機能/Navigator連携機能を利用する場合に、帳票に配置する入力データの抽出条件となる固有情報を指定します。
XBRLデータ対応機能/Navigator連携機能を利用する場合に、帳票に配置する入力データの抽出条件となる固有情報を指定します。
固有情報は、「キー名=値」の形式を「ダブルクォーテーション（"）」で囲んで指定します。
「キー名=値」を囲む「ダブルクォーテーション（"）」は、特別な意味を持つため直前に「円マーク（\）」などを指定し、特別な意味を取り消す必要があります。
複数指定する場合は、各固有情報を「セミコロン（;）」で区切って指定します。
このパラメータを指定する場合は、必ずパラメータ全体を「ダブルクォーテーション（"）」で囲んでください。
例）以下に、指定例を示します。
固有情報を1つ指定する場合
"\"キー名=値\""
固有情報を複数指定する場合
"\"キー名=値\";\"キー名=値\";\"キー名=値\""
キーとその指定値の詳細については、以下のマニュアルを参照してください。
オンラインマニュアル“XBRLデータ対応機能編”
オンラインマニュアル“Navigator連携機能編”
PrintException
マルチフォーム出力する場合、使用する帳票をChangeFormプロパティで切り替え、使用する帳票ごとに、このメソッドで固有情報を指定します。
|
|
帳票定義情報およびsetDataSourceメソッドの定義にしたがって入力データを抽出します。
帳票定義情報およびsetDataSourceメソッドの定義にしたがって入力データを抽出し、CSV形式のテキストファイルとして出力する場合に、出力するファイルのファイル名をフルパスで指定してください。
なお、出力されるテキストファイルは、項目名ラベル付きデータとなります。
PrintException
このメソッドでは、CSV形式のマルチフォーム出力用の入力データファイル（項目名ラベル付きデータ）が出力されます。
FormsFileクラスでこのメソッドで出力したファイルを入力データファイルとして利用できます。その場合は、以下のようにマルチフォーム出力で項目名ラベル付きデータとして扱うように指定してください。
PrintPropertiesクラスのLabelDataプロパティで、「true」を指定してください。
FormsFileクラスのGrpOutプロパティで、「GRPOUT_GRP」を指定してください。
FormsFileクラスのGrpDelimitModeプロパティで、「DELIMIT_ANY」を指定してください。
FormsFileクラスのGrpDelimitプロパティで、「カンマ（,）」を指定してください。
FormsFileクラスのDataFileプロパティで、データファイル名を指定してください。
FormsFileクラスのDataCodeプロパティで、入力データの文字コード系を指定してください。
Navigator連携機能を利用する場合、DataCodeプロパティでデータファイルの文字コード系にShift-JISを指定してください。
帳票名や帳票格納ディレクトリについては、Formsクラスのコンストラクタ、およびChangeFormプロパティで指定してください。
出力されるCSV形式のテキストファイルの文字コード系については、FormsクラスのDataCodeプロパティで指定してください。
帳票の入力データ形式が「XML形式」の場合は、このクラスを使用して帳票出力できません。FormsFileクラスを使用してください。
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。