帳票の出力時に使用する帳票と入力データを保持するクラスです。
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 から継承した文字コードを意味するフィールドについては、以下を参照してください。
⇒“6.4.1.1 フィールドの概要”
FormsFileクラスのコンストラクタを以下に示します。
コンストラクタの概要 |
|---|
帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsFileを作成します。 |
*1：
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。
FormsFileクラスのプロパティを以下に示します。
プロパティの分類 | プロパティ名（プロパティの設定内容） | データ型 |
|---|---|---|
ScriptFile（帳票名）(*1) | string | |
DataFile（データファイル名）(*1) (*2) | string | |
string | ||
int | ||
int | ||
int | ||
string | ||
int | ||
string | ||
bool | ||
string |
*1：
以下に、1つの帳票を出力する場合、マルチフォーム出力する場合、または組合せフォーム出力する場合の必須プロパティの違いを示します。
‐1つの帳票を出力する場合
ScriptFileプロパティ
‐マルチフォーム出力する場合
DataFileプロパティ
GrpOutプロパティ
GrpDelimitModeプロパティ
LcFormプロパティ
‐組合せフォーム出力する場合
DataFileプロパティ
GrpDelimitModeプロパティ
LcFormプロパティ
CbFormプロパティ
ただし、スタンドアロン型で帳票出力する場合、またはコネクタ連携時に帳票を転送しない場合、LcFormプロパティを指定する必要はありません。
*2：
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。
|
帳票格納ディレクトリを指定して、帳票と入力データのセットを保持するFormsFileを作成します。
帳票格納ディレクトリをフルパスで指定します。
帳票格納ディレクトリは、アプリケーションサーバの帳票格納ディレクトリを指定してください。
PrintException
コネクタ連携時に帳票を転送しない場合、帳票出力サーバの帳票格納ディレクトリは、PrintPropertiesクラスのRemoteDirectoryプロパティで指定してください。
帳票格納ディレクトリ名を指定する場合、以下の注意事項があります。
帳票名を指定します。
1つの帳票を出力する場合（マルチフォーム出力、または組合せフォーム出力をしない場合）は、このプロパティを必ず指定してください。
List Creatorの入力データのファイル名を259バイト以内のフルパスで指定します。
マルチフォーム出力する場合（GrpOutプロパティを指定した場合）、または組合せフォーム出力する場合（CbFormプロパティを指定した場合）は、このプロパティを必ず指定してください。
コネクタ連携時に、1つの帳票を出力する場合（ScriptFileプロパティを指定した場合）に省略すると、データファイルは転送されず、帳票出力サーバ上の帳票格納ディレクトリ配下の帳票名と同名のデータファイル（「帳票名.dat」）が指定されたものとして動作します。
入力データ形式が「XML形式」で、XMLルートとデータルートが異なる場合に、XMLデータ中のデータルートの親要素のパスを指定します。
データルートの親要素のパスは、「スラッシュ（/）」を始点にデータルートの親要素までの要素名を「スラッシュ（/）」で区切って指定します。それ以外の形式は指定できません。
XMLデータ中のこのプロパティで指定したパス直下にデータルートが複数存在する場合は、すべてのデータルートを検索します。
このプロパティの呼び出しを省略すると、以下の優先順序でXMLデータからデータルートを検索します。
XMLルートとデータルートが同じ名前の場合、XMLルートをデータルートとみなします。
XMLルートとデータルートが異なる場合、XMLルート直下の子要素の中からデータルートを検索します。
入力データの文字コードを指定します。
Shift-JIS
UNICODE（UTF16リトルエンディアン）
UNICODE（UTF16ビッグエンディアン）
UNICODE（UTF8）
UNICODE（UTF32 リトルエンディアン）
UNICODE（UTF32 ビッグエンディアン）
このプロパティの呼び出しを省略すると、以下の文字コード系になります。
ローカル帳票出力する場合
環境設定画面の［全般］タブで指定した文字コードが有効になります。
コネクタ連携機能を使用する場合
必ずShift-JISの文字コード系になります。
注意
入力データ形式が「XML形式」の場合は、このプロパティの指定は無効になります。
入力データ形式が「XML形式」の場合は、XMLファイル中のXML宣言で文字コード系を指定します。XMLファイル中のXML宣言を省略した場合、またはXML宣言で文字コード系の指定を省略した場合は、UNICODE（UTF8）とみなします。
Unicodeの文字が定義されている帳票定義情報を使用する場合、UNICODEのいずれかを指定してください。
英語環境（英語ロケール）で帳票出力する場合は、UNICODEのいずれかを指定してください。
マルチフォーム出力するかどうかを指定します。
マルチフォーム出力しません（1つの帳票を出力します）。
マルチフォーム出力します。
マルチフォーム出力する場合は、入力データから帳票名を取り出すための区切り文字の種別をGrpDelimitModeプロパティで指定してください。また、必要に応じて、実際に使用する区切り文字をGrpDelimitプロパティで、データファイル中の帳票名データのフィールド長をGrpBytesプロパティで指定してください。
このプロパティの呼び出しを省略すると、「GRPOUT_NOGRP」が指定されたものとして動作します。
ポイント
OWFファイル生成時にマルチフォーム出力する場合（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）は、必ずLcFormプロパティで帳票名を指定してください。
コネクタ連携時にマルチフォーム出力する場合（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）は、LcFormプロパティで（マルチフォームで使用する）帳票名を指定して帳票を転送するか、PrintPropertiesクラスのSendResourceプロパティで「RESOURCE_NOSEND」を指定して（マルチフォームで使用する帳票を転送しないで）帳票出力サーバに配置した帳票の帳票格納ディレクトリを指定（PrintPropertiesクラスのRemoteDirectoryプロパティを指定）してください。
入力データから帳票名を取り出すための区切り文字の種別を指定します。
マルチフォーム出力する場合（GrpOut プロパティに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（CbFormプロパティに「true」を指定した場合）は、このプロパティを必ず指定してください。
区切り文字の種別は、データ定義画面の［環境定義］タブで指定した入力データ形式と区切り文字にしたがって指定します。
以下の場合に指定します。
入力データ形式が「可変長」、区切り文字が「バーティカルバー（|）」「シャープ（#）」「アスタリスク（*）」「任意」のいずれかの場合
入力データ形式が「CSV形式」、区切り文字が「カンマ（,）」の場合
入力データ形式が「可変長」、区切り文字が「1個以上の空白」の場合に指定します。
以下の場合に指定します。
入力データ形式が「可変長」、区切り文字が「タブ」の場合
入力データ形式が「CSV形式」、区切り文字が「タブ」の場合
入力データ形式が「固定長」、区切り文字が「区切り文字なし」の場合に指定します。
入力データ形式が「固定長」、区切り文字が「区切り文字あり」の場合に指定します。
入力データ形式が「XML形式」の場合に指定します。
任意の区切り文字を使用する場合（このプロパティに「DELIMIT_ANY」を指定した場合）は、実際に使用する区切り文字をGrpDelimitプロパティで指定してください。
入力データ形式が「固定長」の場合（このプロパティに「DELIMIT_FIXED」または「DELIMIT_FIXEDDELIMIT」を指定した場合）は、帳票名データのフィールド長を
GrpBytesプロパティで必ず指定してください。
マルチフォーム出力する場合（GrpOut プロパティに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（CbFormプロパティに「true」を指定した場合）で、任意の区切り文字を使用する場合（GrpDelimitModeプロパティに「DELIMIT_ANY」を指定した場合）に、実際に使用する区切り文字を指定します。区切り文字は、データ定義画面の［環境定義］タブで指定した入力データ形式と区切り文字にしたがって指定します。
このプロパティの呼び出しを省略すると、「バーティカルバー（|）」が指定されたものとして動作します。
注意
組合せフォーム出力する場合、「コロン（:）」は指定しないでください
ポイント
入力データの文字コードがUnicodeの場合、文字コードが0x007F/0x7F以下の文字を指定してください。
マルチフォーム出力する場合（GrpOutプロパティに「GRPOUT_GRP」を指定した場合）に、データファイル中の帳票名データのフィールド長を指定します。
入力データ形式が「固定長」の場合（GrpDelimitModeプロパティに「DELIMIT_FIXED」または「DELIMIT_FIXEDDELIMIT」を指定した場合）は、このプロパティを必ず指定してください。区切り文字ありの場合は、区切り文字を含まない長さを指定してください。
マルチフォーム出力する場合（GrpOut プロパティに「GRPOUT_GRP」を指定した場合）、または組合せフォーム出力する場合（CbFormプロパティに「true」を指定した場合）に、使用する帳票名を指定します。
コネクタ連携時にマルチフォーム出力/組合せフォーム出力する場合は、このプロパティで帳票名を指定するか、帳票出力サーバに配置した帳票の帳票格納ディレクトリを指定（PrintPropertiesクラスのRemoteDirectoryプロパティを指定）してください。
複数の帳票名を、「セミコロン（;）」で区切って指定します。
注意
このプロパティは、コネクタ連携時およびOWFファイル生成時のみ有効になります。
OWFファイル生成時にマルチフォーム出力/組合せフォーム出力する場合は、必ずこのプロパティで帳票名を指定してください。
コネクタ連携時にマルチフォーム出力/組合せフォーム出力する場合は、このプロパティで帳票名を指定して帳票を転送するか、PrintPropertiesクラスのSendResourceプロパティで「RESOURCE_NOSEND」を指定して（マルチフォーム/組合せフォームで使用する帳票を転送しないで）帳票出力サーバに配置した帳票の帳票格納ディレクトリを指定（PrintPropertiesクラスのRemoteDirectoryプロパティを指定）してください。
組合せフォーム出力するかどうかを指定します。
組合せフォーム出力しません。
組合せフォーム出力します。
組合せフォーム出力する場合は、GrpDelimitModeプロパティ、およびGrpDelimitプロパティで帳票名データ区切り文字を指定してください。
このプロパティの呼び出しを省略すると、組合せフォーム出力は行われません。
ポイント
OWFファイル生成時に組合せフォーム出力する場合は、必ずLcFormプロパティで帳票名を指定してください。
コネクタ連携時に組合せフォーム出力する場合は、LcFormプロパティで（組合せフォームで使用する）帳票名を指定して帳票を転送するか、PrintPropertiesクラスのSendResourceプロパティで「RESOURCE_NOSEND」を指定して（組合せフォームで使用する帳票を転送しないで）帳票出力サーバに配置した帳票の帳票格納ディレクトリを指定（PrintPropertiesクラスのRemoteDirectoryプロパティを指定）してください。
組合せフォーム定義ファイル名をフルパスで指定します。
組合せフォーム定義ファイルとは、組み合わせて出力する帳票定義情報と、帳票定義情報の重なり順などが定義されたファイルです。
このプロパティの呼び出しを省略すると、帳票格納ディレクトリ配下の組合せフォーム定義ファイル（Lccbform.ini）が有効になります。
注意
組合せフォーム定義ファイルの文字コード系については、オンラインマニュアル“帳票設計編”を参照してください。
コネクタ連携時に、アプリケーションサーバから組合せフォーム定義ファイルを転送した場合、組合せフォーム定義ファイルは、このプロパティとLcFileプロパティの両方で指定してください。その場合、このプロパティには、ファイル名のみ指定してください。
以下に、1つの帳票を出力する場合、マルチフォーム出力する場合、または組合せフォーム出力する場合の必須プロパティの違いを示します。
1つの帳票を出力する場合
ScriptFileプロパティ
マルチフォーム出力する場合
DataFileプロパティ
GrpOutプロパティ
GrpDelimitModeプロパティ
LcFormプロパティ
組合せフォーム出力する場合
DataFileプロパティ
GrpDelimitModeプロパティ
LcFormプロパティ
CbFormプロパティ
ただし、スタンドアロン型で帳票出力する場合、またはコネクタ連携時に帳票を転送しない場合、LcFormプロパティを指定する必要はありません。
サポートしている文字コード系については以下を参照してください。
ファイル名、ファイルの格納先の指定に関する注意事項については、以下を参照してください。