帳票の出力時に使用する帳票と入力データを保持します。
入力データをファイルで扱う場合に使用します。
fujitsu.listcreator.FormBase
└─fujitsu.listcreator.FormsFile
public class FormsFile : FormBaseFormsFileクラスのGrpOutプロパティで指定するフィールドを以下に示します。
定数 | 説明 |
|---|---|
GRPOUT_NOGRP | マルチフォーム出力しません。 |
GRPOUT_GRP | マルチフォーム出力します。 |
FormsFileクラスのGrpDelimitModeプロパティで指定するフィールドを以下に示します。
定数 | 説明 |
|---|---|
DELIMIT_ANY | 以下の場合に指定します。
|
DELIMIT_SPACE | 入力データ形式が「可変長」、区切り文字が「1個以上の空白」の場合に指定します。 |
DELIMIT_TAB | 以下の場合に指定します。
|
DELIMIT_FIXED | 入力データ形式が「固定長」、区切り文字が「区切り文字なし」の場合に指定します。 |
DELIMIT_FIXEDDELIMIT | 入力データ形式が「固定長」、区切り文字が「区切り文字あり」の場合に指定します。 |
DELIMIT_XML | 入力データ形式が「XML形式」の場合に指定します。 |
fujitsu.listcreator.FormBase から継承した文字コードを意味するフィールドについては、以下を参照してください。
FormsFileクラスのコンストラクタを以下に示します。
コンストラクタの概要 | |
|---|---|
帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsFileオブジェクトを生成します。 | |
*1：
帳票格納ディレクトリに、全角文字および半角カナ文字は指定できません。
FormsFileクラスのプロパティを以下に示します。
分類 | プロパティ名（プロパティの設定内容） | データ型 |
|---|---|---|
ScriptFile（帳票名） (*1) | string | |
DataFile（データファイル名） (*1) | string | |
string | ||
int | ||
GrpOut（マルチフォーム出力指定） (*1) | int | |
int | ||
string | ||
int | ||
string | ||
CbForm（組合せフォーム出力指定） (*1) | bool | |
string |
*1：
以下に、指定が必須なプロパティについて示します。
・ 1つの帳票を出力する場合
- ScriptFileプロパティ
- DataFileプロパティ
・ マルチフォーム出力する場合
- DataFileプロパティ
- GrpOutプロパティ
- GrpDelimitModeプロパティ
- LcFormプロパティ
・組合せフォーム出力する場合
- DataFileプロパティ
- GrpDelimitModeプロパティ
- LcFormプロパティ
- CbFormプロパティ
- CbFileプロパティ
ただし、以下の場合はLcFormプロパティを指定する必要はありません。
・ 帳票出力サーバに帳票定義情報を配置する場合
・ List Creatorコネクタ連携時に、帳票管理サーバに帳票定義情報を配置する場合
|
用途
帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsFileオブジェクトを生成します。
パラメータ
帳票管理サーバでユーザアプリケーションを実行する場合は、帳票管理サーバの帳票格納ディレクトリをフルパスで指定します。省略すると、帳票管理サーバの環境設定ファイルのLmlcFormDirキーの指定が有効になります。
List Creatorコネクタ連携時は、アプリケーションサーバの帳票格納ディレクトリをフルパスで指定します。省略した場合、List Creator Connectorの環境設定で指定した帳票格納ディレクトリが有効となります。List Creator Connectorの環境設定については、List Creator Connectorに添付のオンラインマニュアルを参照してください。
例外
PrintException
注意
帳票定義情報の配置場所と指定方法については、以下を参照してください。
⇒“付録A 帳票資源の指定方法”
帳票格納ディレクトリ名の末尾には、「円マーク（\）」を指定しないでください。
帳票名または帳票格納ディレクトリに、全角文字および半角カナ文字は指定できません。
指定できる文字については、以下を参照してください。
⇒“第8章 List Manager帳票出力インタフェースで指定できる文字”
また、List Creatorコネクタ連携時、アプリケーションサーバから帳票出力サーバにファイルを転送するときに指定可能なパス長については、以下を参照してください。
⇒“5.6.2 List Creatorコネクタ連携時の注意事項”
帳票管理サーバがWindowsの場合、帳票格納ディレクトリとして、ネットワークドライブ（UNC 指定（¥¥コンピュータ名¥共有名¥ディレクトリ名）を除く）、およびリムーバブルディスクを指定しないでください。
List Creatorコネクタ連携時、アプリケーションサーバのファイルの格納先として指定できるのは、ローカルディスクのみです。ネットワークドライブ、UNC指定（\\コンピュータ名\共有名\ディレクトリ名）、またはリムーバブルディスクを格納先として指定しないでください。
ポイント
帳票出力サーバに帳票定義情報を配置した場合、このコンストラクタで帳票格納ディレクトリを指定しないでください。指定しない場合、帳票出力サーバの環境設定ファイルのLmlcFormDir キーで指定した帳票格納ディレクトリの指定が有効になります。
List Creatorコネクタ連携時、帳票管理サーバに帳票定義情報を配置する場合は、帳票管理サーバの帳票格納ディレクトリをPrintPropertiesクラスのRemoteDirectoryプロパティで指定してください。
RemoteDirectoryプロパティを指定しない場合は、帳票管理サーバの環境設定ファイルのLmlcFormDirキーの指定が有効となります。
●ユーザ資源情報に関するプロパティ
帳票を出力するときに使用する帳票名を指定します。
帳票属性の編集コマンド（lmedtformatrコマンド）で定義した帳票名を指定します。
注意
1つの帳票を出力する場合（マルチフォーム出力、または組合せフォーム出力をしない場合）は、このプロパティを必ず指定してください。
入力データのファイル名を250バイト以内のフルパスで指定します。
List Managerで帳票配信・出力する場合、このプロパティは必ず指定してください。
注意
List Creatorコネクタ連携時は、アプリケーションサーバに配置したデータファイル名のフルパスを指定します。指定できる範囲については、以下を参照してください。
⇒“5.6.2 List Creatorコネクタ連携時の注意事項”
FormsFileクラスを使用して、List Managerで帳票配信・出力する場合、入力データファイル名を必ず指定してください。
ポイント
List Creatorコネクタ連携時、帳票管理サーバに転送された入力データは、帳票出力後に削除されます。帳票資源の扱いについては、オンラインマニュアル“帳票印刷配信機能 運用ガイド”を参照してください。
データファイルを使用する場合、帳票定義情報の設計時に、List Creatorデザイナのデータ定義画面の［DB連携］タブのDBタイプに「データファイル」を指定しておく必要があります。
XML形式の入力データを使用する場合には、別途必要となる関連ソフトウェア製品があります。詳細については、オンラインマニュアル“帳票印刷配信機能 スタートガイド”の“5.3 ソフトウェア環境”を参照してください。
入力データ形式が「XML形式」で、XMLルートとデータルートが異なる場合に、XMLデータ中のデータルートの親要素のパスを指定します。
データルートの親要素のパスは、「スラッシュ（/）」を始点にデータルートの親要素までの要素名を「スラッシュ（/）」で区切って指定します。それ以外の形式は指定できません。
XMLデータ中のこのプロパティで指定したパス直下にデータルートが複数存在する場合は、すべてのデータルートを検索します。
このプロパティの呼び出しを省略すると、以下のようにXMLデータからデータルートを検索します。
XMLルートとデータルートが同じ名前の場合
XMLルートをデータルートとみなします。
XMLルートとデータルートが異なる場合
XMLルート直下の子要素の中からデータルートを検索します。
入力データの文字コードを指定します。
Shift-JIS
UNICODE（UCS2リトルエンディアン）
UNICODE（UCS2ビッグエンディアン）
UNICODE（UTF8）
このプロパティの呼び出しを省略すると、Shift-JISコード系となります。
注意
入力データ形式が「XML形式」の場合は、このプロパティの指定は無効になります。
入力データ形式が「XML形式」の場合は、XMLファイル中のXML宣言で文字コード系を指定します。XMLファイル中のXML宣言を省略した場合、またはXML宣言で文字コード系の指定を省略した場合は、Shift-JISとみなします。
Unicode の文字が定義されている帳票定義情報を使用する場合「CODE_UCS2LE」、「CODE_UCS2BE」または「CODE_UTF8」を指定してください。
●マルチフォーム出力/組合せフォーム出力用ユーザ資源情報に関するプロパティ
マルチフォーム出力するかどうかを指定します。
マルチフォーム出力しません（1つの帳票を出力します）。
マルチフォーム出力します。
マルチフォーム出力する場合は、入力データから帳票名を取り出すための区切り文字の種別をGrpDelimitModeプロパティで指定してください。また、必要に応じて、実際に使用する区切り文字をGrpDelimitプロパティで、データファイル中の帳票名データのフィールド長をGrpBytesプロパティで指定してください。
このプロパティの呼び出しを省略すると、「GRPOUT_NOGRP」が指定されたものとして動作します。
ポイント
マルチフォーム出力する場合（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）は、必ずLcFormプロパティで帳票名を指定してください。
List Creatorコネクタ連携時にマルチフォーム出力する場合（GrpOutプロパティに「GROUP_OUT」を指定した場合）はLcFormプロパティで（マルチフォームで使用する）帳票名を指定して帳票を転送するか、PrintPropertiesクラスのSendResourceプロパティで「RESOURCE_NOSEND」を指定して（マルチフォーム出力で使用する帳票を転送しないで）帳票管理サーバに配置した帳票の帳票格納ディレクトリを指定（PrintPropertiesクラスのRemoteDirectoryプロパティを指定）してください。
マルチフォーム出力する場合に、入力データ中の帳票名データと出力データの区切り文字を指定します。
マルチフォーム出力する場合（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（CbForm プロパティに「true」を指定した場合）は、このプロパティを必ず指定してください。
区切り文字の種別は、List Creatorデザイナのデータ定義画面の［環境定義］タブで指定した入力データ形式と区切り文字にしたがって指定します。
以下の場合に指定します。
入力データ形式が「可変長」、区切り文字が「バーティカルバー（|）」「シャープ（#）」「アスタリスク（*）」「任意」のいずれかの場合
入力データ形式が「CSV形式」、区切り文字が「カンマ（,）」の場合
入力データ形式が「可変長」、区切り文字が「1個以上の空白」の場合に指定します。
以下の場合に指定します。
入力データ形式が「可変長」、区切り文字が「タブ」の場合
入力データ形式が「CSV形式」、区切り文字が「タブ」の場合
入力データ形式が「固定長」、区切り文字が「区切り文字なし」の場合に指定します。
入力データ形式が「固定長」、区切り文字が「区切り文字あり」の場合に指定します。
入力データ形式が「XML形式」の場合に指定します。
注意
任意の区切り文字を使用する場合（このプロパティに「DELIMIT_ANY」を指定した場合）は、実際に使用する区切り文字をGrpDelimitプロパティで指定してください。
マルチフォーム出力する場合、または組合せフォーム出力する場合は、このプロパティを必ず指定してください。
入力データ形式が「固定長」の場合（このプロパティで「DELIMIT_FIXED」または「DELIMIT_FIXEDDELIMIT」を指定した場合）は、帳票名データのフィールド長をGrpBytesプロパティで必ず指定してください。
マルチフォーム出力する場合（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（CbForm プロパティに「true」を指定した場合）で、任意の区切り文字を使用する場合（GrpDelimitModeプロパティに「DELIMIT_ANY」を指定した場合）に、実際に使用する区切り文字を指定します。
区切り文字は、List Creatorデザイナのデータ定義画面の［環境定義］タブで指定した入力データ形式と区切り文字にしたがって指定します。
このプロパティの呼び出しを省略すると、「バーティカルバー（|）」が指定されたものとして動作します。
注意
組合せフォーム出力する場合、「コロン（:）」は指定しないでください。
ポイント
入力データの文字コード系がUNICODE（UCS2/UTF8）の場合、文字コードが0x007F/0x7F以下の文字を指定してください。
マルチフォーム出力する場合（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）に、データファイル中の帳票名データのフィールド長を指定します。
入力データ形式が「固定長」の場合（GrpDelimitModeプロパティに「DELIMIT_FIXED」または「DELIMIT_FIXEDDELIMIT」を指定した場合）は、このプロパティを必ず指定してください。
区切り文字ありの場合は、区切り文字を含まない長さを指定してください。
マルチフォーム出力時（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（CbForm プロパティに「true」を指定した場合）に、使用する帳票名を指定します。
複数の帳票名を、「セミコロン（;）」で区切って指定します。
注意
マルチフォーム出力/組合せフォーム出力する場合は、必ずこのプロパティで帳票名を指定してください。
ポイント
マルチフォーム出力する場合、このプロパティで指定した帳票名のうち、先頭に指定した帳票名の以下の情報がすべての帳票に対して有効となります。
帳票属性の編集コマンド（lmedtformatrコマンド）で指定する帳票属性に関する情報
プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定するプリンタ構成に関する情報
List Creatorデザイナで指定した帳票出力に関する情報
ただし、プロパティの指定方法によっては、帳票ごとに切り替えることが可能な情報があります。マルチフォーム出力時の留意事項については、以下を参照してください。
⇒List Creatorに添付のオンラインマニュアル“帳票設計編”
入力データ形式が「XML形式」でマルチフォーム出力時、帳票に置換フォントが設定されている場合、指定する先頭の帳票の置換フォントの設定が有効になります。
以下に、1 つの帳票を出力する場合、マルチフォーム出力する場合、または組合せフォーム出力する場合の必須プロパティの違いを示します。
1つの帳票を出力する場合
ScriptFileプロパティ
DataFileプロパティ
マルチフォーム出力する場合
DataFileプロパティ
GrpOutプロパティ
GrpDelimitModeプロパティ
LcFormプロパティ
組合せフォーム出力する場合
DataFileプロパティ
GrpDelimitModeプロパティ
LcFormプロパティ
CbFormプロパティ
CbFileプロパティ
文字コード系については以下を参照してください。
⇒“C.3 .NETインタフェース使用時の文字コード系”
List Creatorコネクタ連携時の文字コード系については、以下を参照してください。
⇒“付録D 文字 コード系に関する注意事項（List Creatorコネクタ連携時）”