4.7.5 PrintPropertiesクラス

PrintPropertiesクラスのsetPropertyメソッドで指定するフィールド（キー）を以下に示します。

PrintPropertiesクラスのsetPropertyメソッドで指定するフィールド

分類	定数（定数の設定内容）	サポート状況
分類	定数（定数の設定内容）	LM	LC-C
List Manager管理情報に関するキー	ID_LM_LOGICALDESTINATION（論理あて先名の指定） (*1)	◎	◎
	ID_LM_REQUESTTERMINAL（依頼元端末の指定）	○	○
	ID_LM_CREATEFORMUSER（作成ユーザ名の指定）	○	○
	ID_LM_OUTMODE（帳票作成後の出力指定）	○	○
	ID_LM_KEEPFORMMODE（帳票出力後の保存指定）	○	○
	ID_LM_TERM（保存日数の指定）	○	○
	ID_LM_OPRIDINFO（業務あて先名）	○	○
	ID_LM_INFOFILE（List Manager管理情報ファイル名）	○	○
ユーザ資源情報に関するキー	ID_BARCODEDATA（バーコードデータのBASE64エンコード指定）	○	○
	ID_VISUALDIR（メディアデータ格納ディレクトリ）	○	○(*2)
	ID_CMVISUALFILE（メディアデータファイル名）(*8)	○	○(*2)
識別情報に関するキー	ID_TITLE（タイトル）	○	○
	ID_COMMENT（コメント）	○	○
	ID_USERID（出力ユーザ）	○	○
動作情報に関するキー	ID_STARTPAGE（開始ページ番号）	○	○
	ID_ENDPAGE（終了ページ番号）	○	○
	ID_DIRECTMETHOD（出力方法）	－	－
	ID_OUTPUTMODE（出力方法）	－	－
	ID_REPLACESTRING（SET演算子の置換文字列）	○	○
	ID_OUTPUTSCALE（用紙サイズに合わせた拡大/縮小）	○	○
	ID_STARTPOSITIONGRIDUNIT（原点位置指定時の単位）	○	○
	ID_STARTPOSITIONX（原点位置指定（印刷時開始時の横方向位置））	○	○
	ID_STARTPOSITIONY（原点位置指定（印刷時開始時の縦方向位置））	○	○
	ID_LFCODE（改行コード制御指定）	○	○
	ID_FFCODE（改ページコード制御指定）	○	○
	ID_NODATA（入力データにデータがない場合の動作指定）	○	○
	ID_LABELDATA（項目名ラベル付きデータ指定）	○	○
	ID_MAPFONTFILE（置換フォント情報ファイル名）	○	○
	ID_BCODADJUST（バーコード補正情報ファイル名）	○	○
	ID_PRINTENVFILE（帳票出力情報ファイル名）	○	○
印刷情報に関するキー	ID_PRTDEVNAME（印刷機種名）	－	－
	ID_PRINTER（印刷プリンタ名）	－	－
	ID_PRINTBIN（給紙方法）	－	－
	ID_PRINTBINNAME（給紙口名）	－	－
	ID_ITEMPRINTBIN（給紙方法/給紙口名切り替え指定）	○	○
	ID_COPYNUMBER（印刷部数）	○	○
	ID_COPYNUMBERCOLLATE（部単位で印刷）	○	○
	ID_PRINTSIDE（印刷面指定）	○	○
	ID_ITEMPRINTSIDE（印刷面切り替え指定）	○	○
	ID_PAPERCODE（用紙コード（用紙名））	－	－
電子保存情報に関するキー(*3)	ID_LW_DRVNAME（電子保存装置名）	－	－
	ID_LW_MAKER（電子保存時の作成者）	○	○
	ID_LW_GENERATEDAY（電子保存時の作成日）	○	○
	ID_LW_GENERATETIME（電子保存時の作成時間）	○	○
	ID_LW_KEEPDIR（電子保存時の保管フォルダパス名）	○	○
	ID_LW_NOTE1（電子保存時の備考1）	○	○
	ID_LW_NOTE2（電子保存時の備考2）	○	○
	ID_LW_NOTE3（電子保存時の備考3）	○	○
	ID_LW_NOTE4（電子保存時の備考4）	○	○
	ID_LW_TERM（電子保存時の有効期限日数）	○	○
	ID_LW_DELTYPE（電子保存時の有効期限経過後の自動削除指定）	○	○
	ID_LW_SEARCH（電子保存時の抜き出し検索指定）	○	○
	ID_LW_MAIL（電子保存時のメール送信指定）	○	○
	ID_LW_MAILRCV（電子保存時のメールの宛先）	○	○
	ID_LW_PRINTBIN（電子保存後印刷の給紙方法）	○	○
	ID_LW_PRINTBINNAME（電子保存後印刷の給紙口名）	○	○
	ID_LW_COPYNUMBER（電子保存後印刷の印刷部数）	○	○
	ID_LW_COPYNUMBERCOLLATE（電子保存後印刷の部単位印刷の指定）	○	○
	ID_LW_PRINTSIDE（電子保存後印刷の印刷面指定）	○	○
	ID_LW_ITEMPRINTSIDE（電子保存後印刷の印刷面切り替え指定）	○	○
	ID_LW_FAXSEND（電子保存時のFAX送信者情報）	－	－
	ID_LW_FAXRCV（電子保存時のFAX受信者情報）	－	－
	ID_LW_FAXRCVFILE（電子保存時のFAX受信者情報ファイル名）	－	－
	ID_LW_FAXSUBJECT（電子保存時のFAX送付状の用件）	－	－
	ID_LW_FAXCOMMENT（電子保存時のFAX送付状のコメント）	－	－
	ID_LW_DSTFOLDER（帳票印刷配信時の配信フォルダID）	－	－
	ID_LW_DSTMETHOD（帳票印刷配信指定）	－	－
	ID_LW_STREAMENVFILE（電子帳票情報ファイル名）	○	○
FAX送信情報に関するキー	ID_FAX_DRVNAME（FAX装置名）	－	－
	ID_FAX_SEND（FAX送信時のFAX送信者情報）	－	－
	ID_FAX_RCV（FAX送信時のFAX受信者情報）	－	－
	ID_FAX_RCVFILE（FAX送信時のFAX受信者情報ファイル名）	－	－
	ID_FAX_SUBJECT（FAX送信時のFAX送付状の用件）	－	－
	ID_FAX_COMMENT（FAX送信時のFAX送付状のコメント）	－	－
PDFファイル保存情報に関するキー	ID_KEEPPDF（PDFファイル名） (*4)	○	○
	ID_PDF_SUBTITLE（PDFファイルのサブタイトル）	○	○
	ID_PDF_AUTHOR（PDFファイルの作成者）	○	○
	ID_PDF_PRINT（PDFファイルの印刷許可指定） (*5)	○	○
	ID_PDF_MODIFY（PDFファイルの変更許可指定） (*5)	○	○
	ID_PDF_SELECT（PDFファイルのテキストとグラフィックスの選択許可指定） (*5)	○	○
	ID_PDF_ANNOTATE（PDFファイルの注釈とフォームフィールドの追加と変更許可指定） (*5)	○	○
	ID_PDF_PWD（PDFファイルを開くパスワード）	○	○
	ID_PDF_SECUPWD（PDFファイルのセキュリティオプション変更パスワード）	○	○
	ID_PDF_LIMIT（PDFファイルの閲覧期限/閲覧期間）	○	○
	ID_PDF_EMBED（PDFファイルの文字の埋め込み指定）	○	○
	ID_PDF_EMBEDREFERENCE（PDFファイルの埋め込み文字検索指定）	○	○
	ID_PDF_JPEGQUALITY（PDFファイルのJPEG圧縮時の品質指定）	○	○
	ID_PDF_EMBEDFILE（PDFファイルに添付するファイル名）	○	○
	ID_PDF_AUTOPRINT（PDFファイルの自動印刷指定）	○	○
	ID_PDF_HIDETOOLBAR（PDFファイル表示時のアプリケーションのツールバー表示指定）	○	○
	ID_PDF_HIDEMENUBAR（PDFファイル表示時のアプリケーションのメニューバー表示指定）	○	○
	ID_PDF_FULLSCREEN（PDFファイル表示時のアプリケーションの全画面表示指定）	○	○
	ID_PDF_BOOKMARK（PDFファイルに帳票が切り替わったときにしおりを挿入する指定）	○	○
	ID_PDF_BOOKMARKITEM（PDFファイルにデータが切り替わったときにしおりを挿入する指定）	○	○
	ID_PDF_BOOKMARKITEM2（PDFファイルにデータが切り替わったときにしおり（多階層）を挿入する指定）	○(6)(9)	○(6)(9)
	ID_PDF_DOCENVFILE（PDF文書情報ファイル名）	○	○
	ID_PDF_OUTINFOFILE（ECM情報ファイル名）	－	－
印刷属性情報に関するキー	ID_PRTMODE（出力開始時の動作モード）	○	○
	ID_JOBHRESUME（保留解除日時）	－	－
	ID_JOBPRIORITY（出力時の優先順位）	○	○
	ID_INFORM（メッセージ通知先（通知メッセージ））	○	○
	ID_JOBRMSGHOST（メッセージ通知先（返答メッセージ/応答メッセージ））	○	○
	ID_JOBBANNER（区切りページ出力指定）	○	○
	ID_JOBWAIT（出力完了待ち合わせ）	－	－
	ID_JOBPAPERCODE（用紙交換メッセージ指定）	○	○
	ID_JOBUSERNAME（印刷ドキュメントの所有者名（ユーザ名））	－	－
OWFファイル生成情報に関するキー	ID_KEEPOWF（OWFファイル名） (*4)	○	○
	ID_OWF_DESTINATION（Webプラグイン起動時の動作モード）	○	○
	ID_OWF_OPENPRTDLG（印刷時の印刷画面の表示指定）	○	○
	ID_OWF_PRTCLOSE（印刷終了後にWebブラウザを閉じる指定）	○	○
	ID_OWF_PREVIEWRATE（プレビュー時のズーム率指定）	○	○
	ID_OWF_PRTPREVENTION（プレビュー時の印刷制御指定）	○	○
	ID_OWF_EMBED（OWFファイルへの外字エンベッド指定）	○	○
	ID_OWF_REGFONT（外字フォントファイル登録）	○	○
	ID_OWF_WORKDIRECTRY（OWFファイル生成時の作業ディレクトリ）	－	－
List Creatorコネクタ連携情報に関するキー	ID_HOST（通信対象コンピュータ名） (*1)	－	◎
	ID_COMPRESSRESOURCE（転送データの圧縮指定）	－	○
	ID_SENDRESOURCE（帳票定義情報の転送指定） (*6)	－	○
	ID_UPDATERESOURCE（転送先ディレクトリに同一ファイル名が存在した場合の制御指定）	－	－
	ID_LCVISUALFILE（転送メディアデータファイル名）(*8)	－	○
	ID_REMOTEDIRECTORY（帳票出力時の帳票格納ディレクトリ）	－	○
	ID_LCLWFAXRCVFILE（転送電子保存時のFAX受信者情報ファイル名）	－	－
	ID_LCFAXRCVFILE（転送FAX送信時のFAX受信者情報ファイル名）	－	－
	ID_LCFILE（転送ファイル名） (*6)	－	○
	ID_LCBINFILE（バイナリ転送時の転送ファイル名）	－	○
	ID_RETURNPDFPATH（配置するPDFファイル名） (*4)	－	○
	ID_RETURNOWFPATH（配置するOWFファイル名） (*4)	－	○
	ID_RETURNXLSPATH（生成するExcelファイル名）	－	－
	ID_REMOTEOPTION（リモート帳票出力オプション）	－	－
	ID_REMOTEMODE（リモート帳票出力モード）	－	－
Excelファイル出力情報に関するキー	ID_KEEPXLSX（Excelファイル出力時の格納先ファイル名）	－	－
	ID_XLSX_DOCENVFILE（Excel文書情報ファイル名）	－	－
	ID_XLSX_OUTPUTFORM（Excelファイル出力時の明細の出力方法）	－	－
	ID_XLSX_SHEETNAME（出力するExcelファイルのシート名指定）	－	－
	ID_XLSX_SHEETNAMEITEM（出力するExcelファイルのシート名にする入力データの項目名指定）	－	－
	ID_XLSX_OUTINFOFILE（ECM情報ファイル名）	－	－
TIFF出力情報に関するキー	ID_KEEPTIFF（TIFF出力時の格納先ファイル名）	－	－
その他	ID_EXECBUFFER（帳票出力オプション）	○	○

◎：必須
○：サポート
－：未サポート

LM：帳票配信・出力時
LC-C：List Creator コネクタ連携時

*1： List Managerで帳票配信・出力する場合は、ID_LM_LOGICALDESTINATIONキー、またはsetLogicalDestinationメソッドで必ず「論理あて先名」を指定してください。
また、List Creatorコネクタ連携時は、ID_HOSTキーで必ず帳票管理サーバのホスト名（コンピュータ名）を指定してください。

*2： List Creatorコネクタ連携時、アプリケーションサーバから帳票管理サーバへ以下のファイルを転送する場合は、指定しても無効となります。
・メディアデータファイル

*3：電子保存に関するキーは、Interstage List Manager互換のための機能で使用するオプションです。

*4： PDFファイルおよびOWFファイルの配置先と指定方法について、以下に示します。

運用形態	ファイル形式	ファイルの配置先	setPropertyメソッドでの指定方法
帳票配信型	PDFファイル	帳票出力サーバ	ID_KEEPPDFキー
Web手元印刷型	PDFファイル	アプリケーションサーバ	ID_RETURNPDFPATHキー
	PDFファイル	帳票管理サーバ	ID_KEEPPDFキー
	OWFファイル	アプリケーションサーバ	ID_RETURNOWFPATHキー
	OWFファイル	帳票管理サーバ	ID_KEEPOWFキー

*5：以下のキーを指定する場合、ID_PDF_SECUPWDキーで必ずパスワードを指定してください。
        ・ID_PDF_PRINT
        ・ID_PDF_MODIFY
        ・ID_PDF_SELECT
        ・ID_PDF_ANNOTATE

*6：帳票定義情報を転送する場合の文字コード系については、以下を参照してください。
⇒“D.2.2 アプリケーションサーバがSolaris/Linuxの場合”

*7：本キーは、Interstage List Manager互換のための機能で使用するキーです。

*8：メディアデータファイルの種類は、以下のとおりです。
        ・ビットマップデータ
        ・JPEGデータ
        ・OLE2オブジェクト
        ・TIFFデータ
        ・PNGデータ
        ・グラフデータ（グラフ属性ファイル、およびグラフデータファイル）

*9：帳票管理サーバがSolarisの場合、利用できません。

●List Manager管理情報

PrintPropertiesクラスのsetOutModeメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetOutModeメソッドで指定するフィールド

定数	説明
OUTMODE_DO	List Managerで帳票を作成後、そのまま続けて配信して出力します。
OUTMODE_NONE	List Managerで帳票を作成後、そのまま続けて配信して出力しません（帳票の登録のみ行います）。

PrintPropertiesクラスのsetKeepModeメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetKeepModeメソッドで指定するフィールド

定数	説明
KEEPMODE_DO	帳票出力後に、帳票をList Managerで保存します。
KEEPMODE_NONE	帳票出力後に、帳票をList Managerで保存しません。

●ユーザ資源情報

PrintPropertiesクラスのsetBarCodeDataメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetBarCodeDataメソッドで指定するフィールド

定数	説明
BARDATA_NONE	CODE128、EAN-128の入力データにエンコードしないデータを指定します。
BARDATA_BASE64	CODE128、EAN-128の入力データにBASE64エンコードしたデータを指定します。

●動作情報

PrintPropertiesクラスのsetOutputScaleメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetOutputScaleメソッドで指定するフィールド

定数	説明
OUTPUTSCALE_A3	A3用紙
OUTPUTSCALE_A4	A4用紙
OUTPUTSCALE_A5	A5用紙
OUTPUTSCALE_A6	A6用紙
OUTPUTSCALE_B4	B4用紙
OUTPUTSCALE_B5	B5用紙
OUTPUTSCALE_PS	はがき
OUTPUTSCALE_LT	Letter
OUTPUTSCALE_LG	Legal

PrintPropertiesクラスのsetStartPositionメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetStartPositionメソッドで指定するフィールド

定数	説明
SETSTARTPOS_INCH	インチ単位で指定します。
SETSTARTPOS_MM	ミリ単位で指定します。

PrintPropertiesクラスのsetLFCodeメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetLFCodeメソッドで指定するフィールド

定数	説明
LFCODE_DO	改行コードのみの行は改行処理だけを行います。空の1行が出力されます。
LFCODE_SKIP	改行コードのみの行は読み飛ばします（行に入力データがないものとして処理を行います）。

PrintPropertiesクラスのsetFFCodeメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetFFCodeメソッドで指定するフィールド

定数	説明
FFCODE_DO	改ページ処理を行います。
FFCODE_SKIP	改ページ処理を行わず、改ページコードは読み飛ばします。
FFCODE_NONE	改ページ処理および改ページコードの読み飛ばしを行いません。

●印刷情報

PrintPropertiesクラスのsetPrintSideメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetPrintSideメソッドで指定するフィールド

定数	説明
PRINTSIDE_SINGLEFOLLOW	片面印刷します。マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。
PRINTSIDE_BOTHFOLLOW	両面印刷します。マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。
PRINTSIDE_SINGLE	片面印刷します。マルチフォーム出力する場合は、帳票を切り替えたときに新しい用紙に印刷します。
PRINTSIDE_BOTH	両面印刷します。マルチフォーム出力する場合は、帳票を切り替えたときに新しい用紙に印刷します。

●電子保存情報

以下の各メソッドで指定するフィールドは、Interstage List Manager互換のための機能で使用するフィールドです。

setListSearch メソッド
setListMail メソッド
setListPrintBin メソッド
setListCopyNumber メソッド
setListPrintSide メソッド

PrintPropertiesクラスのsetListSearchメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetListSearchメソッドで指定するフィールド

定数	説明
LISTSEARCH_FOLDER	リスト管理サーバの保管フォルダの設定にしたがいます。
LISTSEARCH_FALSE	抜き出し検索を有効にしません。
LISTSEARCH_TRUE	抜き出し検索を有効にします。

PrintPropertiesクラスのsetListMailメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetListMailメソッドで指定するフィールド

定数	説明
LISTMAIL_SERVER	リスト管理サーバの設定にしたがいます。
LISTMAIL_FALSE	リスト管理サーバに帳票が登録されたことをメールで送信しません。
LISTMAIL_ENTRY	リスト管理サーバに帳票が登録されたことをメールで送信します。送信時には、帳票エントリファイルを添付して送信します。
LISTMAIL_FILE	リスト管理サーバに帳票が登録されたことをメールで送信します。送信時には、帳票ファイルを添付して送信します。

PrintPropertiesクラスのsetListPrintBinメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetListPrintBinメソッドで指定するフィールド

定数	説明
LISTBIN_CF	カットシートフィーダ
LISTBIN_H1	ホッパ1
LISTBIN_H2	ホッパ2
LISTBIN_H3	ホッパ3
LISTBIN_H4	ホッパ4
LISTBIN_MA	手差し
LISTBIN_NO	指定なし（プリンタドライバのプロパティの設定にしたがいます）
LISTBIN_AT	自動

PrintPropertiesクラスのsetListCopyNumberメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetListCopyNumberメソッドで指定するフィールド

定数	説明
LISTCOPY_DEFAULT	指定なし（プリンタドライバのプロパティの設定にしたがいます）
LISTCOPY_TRUE	部単位で印刷します。
LISTCOPY_FALSE	部単位で印刷しません（ページ単位で印刷します）。

定数

説明

LISTCOPY_DEFAULT

指定なし

（プリンタドライバのプロパティの設定にしたがいます）

LISTCOPY_TRUE

部単位で印刷します。

LISTCOPY_FALSE

部単位で印刷しません（ページ単位で印刷します）。

PrintPropertiesクラスのsetListPrintSideメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetListPrintSideメソッドで指定するフィールド

定数	説明
LISTPRINTSIDE_SINGLEFOLLOW	片面印刷します。マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。
LISTPRINTSIDE_BOTHFOLLOW	両面印刷します。マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。
LISTPRINTSIDE_BOTH	両面印刷します。マルチフォーム出力する場合は、帳票を切り替えたときに新しい用紙に印刷します。

定数

説明

LISTPRINTSIDE_SINGLEFOLLOW

片面印刷します。

マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

LISTPRINTSIDE_BOTHFOLLOW

両面印刷します。

マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

LISTPRINTSIDE_BOTH

両面印刷します。

マルチフォーム出力する場合は、帳票を切り替えたときに新しい用紙に印刷します。

●PDFファイル保存情報

PrintPropertiesクラスのsetPdfEmbedメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetPdfEmbedメソッドで指定するフィールド

定数	説明
PDFEMBED_ALL	すべての文字をPDFファイルに埋め込みます。
PDFEMBED_NONE	すべての文字をPDFファイルに埋め込みません。

PrintPropertiesクラスのsetPdfJpegQualityメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetPdfJpegQualityメソッドで指定するフィールド

定数	説明
PDFQUALITY_HIGH	高画質、低圧縮率でJPEG圧縮します。
PDFQUALITY_MID	PDFQUALITY_HIGHとPDFQUALITY_LOWの中間の画質/圧縮率でJPEG圧縮します。
PDFQUALITY_LOW	低画質、高圧縮率でJPEG圧縮します。
PDFQUALITY_NONE	JPEG圧縮されません。画質劣化のないflate圧縮が施されます。

PrintPropertiesクラスのsetPdfAutoPrintメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetPdfAutoPrintメソッドで指定するフィールド

定数	説明
PDFAUTOPRINT_OFF	PDFファイルを自動印刷しません。
PDFAUTOPRINT_OPN	PDFファイルを開くと、自動的に印刷ダイアログボックスを表示します。
PDFAUTOPRINT_OPN_CLS	PDFファイルを開くと、システムで設定されているデフォルトプリンタへ自動的に印刷されます。

●印刷属性情報

PrintPropertiesクラスのsetPrtModeメソッドで指定するフィールドを以下に示します。

PrintPropertiesクラスのsetPrtModeメソッドで指定するフィールド

定数	説明
PRTMODE_OUTPUT	すぐに帳票を出力します。
PRTMODE_HOLDCL	すぐに帳票を出力しないで、いったんクライアント側のスプールに保留します。クライアント側とは、帳票出力サーバが動作するコンピュータを指します。

4.7.5.2 コンストラクタの概要

PrintPropertiesクラスのコンストラクタを以下に示します。

PrintPropertiesクラスのコンストラクタ

コンストラクタの概要
PrintProperties() PrintPropertiesオブジェクトを生成します。

コンストラクタの概要

PrintProperties()

PrintPropertiesオブジェクトを生成します。

4.7.5.3 メソッド一覧

PrintPropertiesクラスのメソッドを以下に示します。

PrintPropertiesクラスを使用して帳票を出力する場合、帳票の出力に関する各属性を以下のsetPropertyメソッドで指定することを推奨します。

PrintPropertiesクラスのメソッド

メソッド一覧
○	void	setProperty(int key, String val)
○	void		帳票配信・出力時に指定するプロパティのキーと値のセットを指定します。指定できるキーと値については、以下を参照してください。 ⇒“4.7.5.5 setPropertyメソッドで指定するキーと値”

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

●List Manager管理情報

PrintPropertiesクラスのメソッド（List Manager管理情報）

分類	メソッド一覧
List Manager管理情報	◎	void	setLogicalDestination (String logicaldestination) (*1)
				List Managerで使用する論理あて先名または論理あて先グループ名を指定します。
				対応するsetPropertyメソッドのキー	ID_LM_LOGICALDESTINATION（論理あて先名の指定）
	○	void	setRequestTerminal(String terminal)
				帳票の作成依頼元を指定します。
				対応するsetPropertyメソッドのキー	ID_LM_REQUESTTERMINAL（依頼元端末の指定）
	○	void	setCreateUser(String user)
				List Managerで帳票を作成するユーザ名を指定します。
				対応するsetPropertyメソッドのキー	ID_LM_CREATEFORMUSER（作成ユーザ名の指定）
	○	void	setOutMode(int outmode)
				List Managerで帳票を作成後、そのまま続けて配信して出力するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_LM_OUTMODE（帳票作成後の出力指定）
	○	void	setKeepMode(int keepmode)
				帳票出力後に、帳票をList Managerで保存するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_LM_KEEPFORMMODE（帳票出力後の保存指定）
	○	void	setKeepDays(int days)
				List Managerで帳票を保存する日数を指定します。
				対応するsetPropertyメソッドのキー	ID_LM_TERM（保存日数の指定）

◎：List Managerで必須としているメソッドです。
○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

*1：setLogicalDestinationメソッドに論理あて先名を指定するか、またはsetPropertyメソッドのID_LM_LOGICALDESTINATIONキーに論理あて先名を指定してください。

●共通

PrintPropertiesクラスのメソッド（共通）

分類	メソッド一覧
ユーザ資源情報に関するメソッド	○	void	setBarCodeData(int barcode)
				バーコードCODE128、EAN-128の入力データのエンコード方法を指定します。
				対応するsetProperty メソッドのキー	ID_BARCODEDATA（バーコードデータのBASE64エンコード指定）
	○	void	setVisualDir(java.lang.String visualdir)
				メディアデータ格納ディレクトリを指定します。
				対応するsetPropertyメソッドのキー	ID_VISUALDIR（メディアデータ格納ディレクトリ）
識別情報に関するメソッド	○	void	setTitle(java.lang.String title)
				タイトルを指定します。
				対応するsetPropertyメソッドのキー	ID_TITLE（タイトル）
	○	void	setComment(java.lang.String comment)
				帳票に関するコメントを指定します。
				対応するsetPropertyメソッドのキー	ID_COMMENT（コメント）
動作情報に関するメソッド	○	void	setStartPage(int page)
				出力を開始するページ番号を指定します。
				対応するsetPropertyメソッドのキー	ID_STARTPAGE（開始ページ番号）
	○	void	setEndPage(int page)
				出力を終了するページ番号を指定します。
				対応するsetPropertyメソッドのキー	ID_ENDPAGE（終了ページ番号）
	－	void	setDirectMethod(int outputmode) setOutputMode(int outputmode)
				帳票の出力方法を指定します。 setDirectMethodメソッドは、帳票で指定されている出力方法に関係なく出力方法を指定したい場合に指定してください。 setOutputModeメソッドは、Formsのコンストラクタで指定した帳票で指定されている出力方法のうち、特定の出力方法で出力したい場合に指定してください。
				対応するsetPropertyメソッドのキー	ID_DIRECTMETHOD（出力方法） ID_OUTPUTMODE（出力方法）
	○	void	setReplaceString(java.lang.String string)
				SET演算子の置換文字列を指定します。
				対応するsetPropertyメソッドのキー	ID_REPLACESTRING（SET演算子の置換文字列）
動作情報に関するメソッド	○	void	setOutputScale(int size)
				指定した用紙サイズに合わせて帳票を拡大または縮小して出力したい場合に、出力したい用紙サイズを指定します。
				対応するsetPropertyメソッドのキー	ID_OUTPUTSCALE（用紙サイズに合わせた拡大/縮小）
	○	void	setStartPosition(int gridunit, float startposx, float startposy)
				帳票出力時の原点位置を指定します。
				対応するsetPropertyメソッドのキー	ID_STARTPOSITIONGRIDUNIT（原点位置指定時の単位） ID_STARTPOSITIONX（原点位置指定（印刷時開始時の横方向位置）） ID_STARTPOSITIONY（原点位置指定（印刷時開始時の縦方向位置））
	○	void	setLFCode(int mode)
				入力データ形式が「可変長」、「固定長」、または「CSV形式」で、入力データ中に改行コードのみの行が存在した場合の制御方法を指定します。
				対応するsetPropertyメソッドのキー	ID_LFCODE（改行コード制御指定）
	○	void	setFFCode(int mode)
				入力データ形式が「可変長」、「固定長」、または「CSV形式」の場合、入力データ中の改ページコードの制御方法を指定します。
				対応するsetPropertyメソッドのキー	ID_FFCODE（改ページコード制御指定）
	○	void	setNoData(boolean nodata)
				入力データ（項目）が0バイトの場合に、エラーとなるかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_NODATA（入力データにデータがない場合の動作指定）

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

●出力方法：印刷

PrintPropertiesクラスのメソッド（出力方法：印刷）

分類	メソッド一覧
印刷情報に関するメソッド	－	void	setPrtDevName(java.lang.String prtdevname)
				Solaris/LinuxでプリンタにFMまたはFNP出力する場合に、使用する印刷機種名を指定します。
				対応するsetPropertyメソッドのキー	ID_PRTDEVNAME（印刷機種名）
	－	void	setPrinter(java.lang.String printer)
				使用する印刷プリンタ名を指定します。
				対応するsetPropertyメソッドのキー	ID_PRINTER（印刷プリンタ名）
	－	void	setPrintBin(int bin)
				用紙種別が「単票」の場合に、印刷プリンタの給紙方法を指定します。
				対応するsetPropertyメソッドのキー	ID_PRINTBIN（給紙方法）
	－	void	setPrintBinName(java.lang.String binname)
				印刷プリンタの給紙口名を指定します。
				対応するsetPropertyメソッドのキー	ID_PRINTBINNAME（給紙口名）
	○	void	setItemPrintBin(java.lang.String bin)
				用紙種別が「単票」で、マルチフォーム出力する場合に、帳票を切り替えたときに給紙方法/給紙口名も切り替える（各帳票で指定した給紙方法/給紙口名を有効にする）かどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_ITEMPRINTBIN（給紙方法/給紙口名切り替え指定）
	○	void	setCopyNumber(int copies, boolean collate)
				帳票の印刷部数、および部単位で印刷するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_COPYNUMBER（印刷部数） ID_COPYNUMBERCOLLATE（部単位で印刷）
	○	void	setPrintSide(int printside)
				以下について指定します。両面印刷するかどうかマルチフォーム出力する場合に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか
				対応するsetPropertyメソッドのキー	ID_PRINTSIDE（印刷面指定）
	○	void	setItemPrintSide(java.lang.String printside)
				マルチフォーム出力する場合で、帳票を切り替えたときに印刷面も切り替える（各帳票で指定した印刷面指定を有効にする）かどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_ITEMPRINTSIDE（印刷面切り替え指定）

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

●出力方法：電子保存（互換機能）

PrintPropertiesクラスのメソッド（出力方法：電子保存）

分類	メソッド一覧
電子保存情報に関するメソッド(*1)	－	void	setListDrvName(java.lang.String drivename)
				使用する電子保存装置名を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_DRVNAME（電子保存装置名）
	○	void	setListMaker(java.lang.String maker)
				帳票の作成者を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_MAKER（電子保存時の作成者）
	○	void	setListGenerateDay(java.lang.String generateday)
				帳票の作成日を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_GENERATEDAY（電子保存時の作成日）
	○	void	setListGenerateTime(java.lang.String generatetime)
				帳票の作成時間を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_GENERATETIME（電子保存時の作成時間）
	○	void	setListKeepDir(java.lang.String path)
				帳票を電子保存するリスト管理サーバ上の保管フォルダのディレクトリ名を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_KEEPDIR（電子保存時の保管フォルダパス名）
	○	void	setListNote1(java.lang.String note1)
				帳票の備考1を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_NOTE1（電子保存時の備考1）
	○	void	setListNote2(java.lang.String note2)
				帳票の備考2を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_NOTE2（電子保存時の備考2）
	○	void	setListNote3(java.lang.String note3)
				帳票の備考3を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_NOTE3（電子保存時の備考3）
	○	void	setListNote4(java.lang.String note4)
				帳票の備考4を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_NOTE4（電子保存時の備考4）
	○	void	setListTerm(int days)
				帳票をリスト管理サーバに登録した日からの有効期限日数を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_TERM（電子保存時の有効期限日数）
	○	void	setListDelType(boolean deltype)
				帳票をリスト管理サーバに登録した日から有効期限を過ぎたらリストクリーナの削除対象とするかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_LW_DELTYPE（電子保存時の有効期限経過後の自動削除指定）
	○	void	setListSearch(int search)
				電子保存時に抜き出し検索を有効にするかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_LW_SEARCH（電子保存時の抜き出し検索指定）
	○	void	setListMail(int mail)
				帳票がリスト管理サーバに登録されたことをメールで通知するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_LW_MAIL（電子保存時のメール送信指定）
	○	void	setListMailRcv(java.lang.String address)
				電子保存時に帳票がリスト管理サーバに登録されたことを通知するメールの宛先を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_MAILRCV（電子保存時のメールの宛先）
	○	void	setListPrintBin(int bin)
				電子保存後の印刷で、用紙種別が「単票」の場合に、印刷プリンタの給紙方法を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_PRINTBIN（電子保存後印刷の給紙方法）
	○	void	setListPrintBinName(java.lang.String binname)
				電子保存後の印刷で、印刷プリンタの給紙口名を指定します。
				対応するsetPropertyメソッドのキー	ID_LW_PRINTBINNAME（電子保存後印刷の給紙口名）
	○	void	setListCopyNumber(int copies, int collate)
				電子保存後の印刷で、帳票の印刷部数、および部単位で印刷するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_LW_COPYNUMBER（電子保存後印刷の印刷部数） ID_LW_COPYNUMBERCOLLATE（電子保存後印刷の部単位印刷の指定）
	○	void	setListPrintSide(int printside)
				電子保存後の印刷で、以下について指定します。両面印刷するかどうかマルチフォーム出力する場合に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか
				対応するsetPropertyメソッドのキー	ID_LW_PRINTSIDE（電子保存後印刷の印刷面指定）
	○	void	setListItemPrintSide(java.lang.String printside)
				電子保存後の印刷で、マルチフォーム出力する場合で、帳票を切り替えたときに新しい用紙に印刷する指定を有効にするかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_LW_ITEMPRINTSIDE（電子保存後印刷の印刷面切り替え指定）

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

*1：電子保存情報に関するオプションは、Interstage List Manager互換のための機能で使用するオプションです。

●出力方法：PDFファイル保存

PrintPropertiesクラスのメソッド（出力方法：PDFファイル保存）

分類	メソッド一覧
PDFファイル保存情報に関するメソッド	○	void	setKeepPdf(java.lang.String path)
				PDFファイル名を指定します。
				対応するsetPropertyメソッドのキー	ID_KEEPPDF（PDFファイル名）
	○	void	setPdfSubTitle(java.lang.String subtitle)
				PDFファイルのサブタイトルを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_SUBTITLE（PDFファイルのサブタイトル）
	○	void	setPdfAuthor(java.lang.String author)
				PDFファイルの作成者を指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_AUTHOR（PDFファイルの作成者）
	○	void	setPdfPrint(boolean print)
				PDFファイルの印刷を許可するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_PRINT（PDFファイルの印刷許可指定）
	○	void	setPdfModify(boolean modify)
				PDFファイルの変更を許可するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_MODIFY（PDFファイルの変更許可指定）
	○	void	setPdfSelect(boolean select)
				PDFファイルのテキストとグラフィックスの選択を許可するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_SELECT（PDFファイルのテキストとグラフィックスの選択許可指定）
	○	void	setPdfAnnotate(boolean annotate)
				PDFファイルの注釈とフォームフィールドの追加と変更を許可するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_ANNOTATE（PDFファイルの注釈とフォームフィールドの追加と変更許可指定）
	○	void	setPdfPwd(java.lang.String password)
				PDFファイルを開くときのパスワードを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_PWD（PDFファイルを開くパスワード）
	○	void	setPdfSecuPwd(java.lang.String password)
				PDFファイルのセキュリティオプションを変更するときのパスワードを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_SECUPWD（PDFファイルのセキュリティオプション変更パスワード）
PDFファイル保存情報に関するメソッド	○	void	setPdfEmbed(int embed)
				PDFファイルに文字を埋め込むかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_EMBED（PDFファイルの文字の埋め込み指定）
	○	void	setPdfEmbed(int embed, boolean reference)
				PDFファイルに文字を埋め込むかどうか、およびPDFファイルに埋め込んだ文字を検索できるようにするかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_EMBED（PDFファイルの文字の埋め込み指定） ID_PDF_EMBEDREFERENCE（PDFファイルの埋め込み文字検索指定）
	○	void	setPdfJpegQuality(int quality)
				PDF ファイルの JPEG 圧縮時の品質を指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_JPEGQUALITY（PDFファイルのJPEG圧縮時の品質指定）
	○	void	setPdfEmbedFile(java.lang.String path)
				PDF ファイルに添付する任意のファイル名をフルパスで指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_EMBEDFILE（PDFファイルに添付するファイル名）
	○	void	setPdfAutoPrint(int autoprint)
				PDFファイルの自動印刷、および印刷実行のタイミングを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_AUTOPRINT（PDFファイルの自動印刷指定）
	○	void	setPdfHideToolbar(boolean hidetoolbar)
				PDFファイルを表示する場合、PDFのビューアのツールバーを表示するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_HIDETOOLBAR（PDFファイル表示時のアプリケーションのツールバー表示指定）
	○	void	setPdfHideMenubar(boolean hidemenubar)
				PDFファイルを表示する場合、PDFのビューアのメニューバーを表示するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_HIDEMENUBAR（PDFファイル表示時のアプリケーションのメニューバー表示指定）
	○	void	setPdfFullscreen(boolean fullscreen)
				PDFファイルを表示する場合、PDFのビューアを全画面で表示するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_PDF_FULLSCREEN（PDFファイル表示時のアプリケーションの全画面表示指定）

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

●印刷属性

PrintPropertiesクラスのメソッド（印刷属性）

分類	メソッド一覧
印刷属性情報に関するメソッド	○	void	setPrtMode (int mode)
				帳票の出力開始時の動作モードを指定します。
				対応するsetPropertyメソッドのキー	ID_PRTMODE（出力開始時の動作モード）
	－	void	setJobHResume(java.lang.String time)
				スプールしたドキュメントの保留状態をいつ解除するかを指定します。
				対応するsetPropertyメソッドのキー	ID_JOBHRESUME（保留解除日時）
	○	void	setJobPriority(int priority)
				帳票の出力処理の優先順位を指定します。
				対応するsetPropertyメソッドのキー	ID_JOBPRIORITY（出力時の優先順位）
	○	void	setInForm(java.lang.String host)
				帳票の出力中に出力装置にエラーが発生した場合の通知メッセージや、出力経過の通知メッセージの通知先を指定します。
				対応するsetPropertyメソッドのキー	ID_INFORM（メッセージ通知先（通知メッセージ））
	○	void	setJobBanner(boolean banner)
				区切りページを出力するかどうかを指定します。
				対応するsetPropertyメソッドのキー	ID_JOBBANNER（区切りページ出力指定）
	－	void	setJobWait(int mode)
				出力完了の待ち合わせモードを指定します。
				対応するsetPropertyメソッドのキー	ID_JOBWAIT（出力完了待ち合わせ）

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

●その他

PrintPropertiesクラスのメソッド（その他）

分類	メソッド一覧
その他	○	void	setExecBuffer(java.lang.String param) (*1)
				Javaインタフェースがサポートしていないprprintコマンドのオプションを指定します。
				対応するsetPropertyメソッドのキー	ID_EXECBUFFER（帳票出力オプション）

○：List Managerでサポートしているメソッドです。
－：List Managerでサポートしていないメソッドです。

*1：
PDFファイル保存情報（メール配信）については、setExecBufferメソッドでprprintコマンドのオプションを指定してください。prprintコマンドのオプションについては、以下を参照してください。
⇒“3.3.1 prprintコマンド”

4.7.5.4 コンストラクタの詳細

public

PrintProperties()

用途

PrintPropertiesオブジェクトを生成します。

4.7.5.5 setPropertyメソッドで指定するキーと値

以下に、setPropertyメソッドで指定するキーとその値について説明します。

●List Manager管理情報に関するキー

ID_LM_LOGICALDESTINATION（論理あて先名の指定）

List Managerで使用する論理あて先名または論理あて先グループ名を80バイト以内で指定します。

このキーが指定されていた場合、List Managerで帳票配信・出力を行います。

List Managerで帳票配信・出力する場合は必ず指定してください。

ID_LM_REQUESTTERMINAL（依頼元端末の指定）

帳票の作成依頼元を255バイト以内で指定します。

帳票の作成依頼元とは、帳票出力の指示を出した端末などを意味します。

このキーを指定すると、依頼元端末をキーワードにして、帳票管理機能で帳票の絞り込みなどができます。

このキーの呼び出しを省略すると、帳票登録を行った帳票管理サーバのホスト名が有効になります。

ポイント

依頼元端末に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_LM_CREATEFORMUSER（作成ユーザ名の指定）

List Managerで帳票を作成するユーザ名を16バイト以内で指定します。

タブは指定しないでください。

ユーザ名を指定すると、そのユーザ名をキーワードに帳票管理機能で帳票の管理や帳票の絞り込みなどができます。

このキーの呼び出しを省略すると、デフォルトユーザ名（lmuser）が有効になります。

ポイント

作成ユーザ名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_LM_OUTMODE（帳票作成後の出力指定）

List Managerで帳票を作成後、そのまま続けて配信・出力するかどうかを指定します。

NONE：: 出力しません（帳票の登録のみ行います）。

DO：: 出力します。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

論理あて先の編集コマンド（lmedtldコマンド）で設定した帳票作成後の出力指定
帳票属性の編集コマンド（lmedtformatrコマンド）で設定した帳票作成後の出力指定

ポイント

List Creatorコネクタ連携時、アプリケーションサーバに帳票（PDFファイルまたはOWFファイル）を配置する場合は、このキーで「DO」を指定する必要があります。
このキーで「NONE」を指定した場合、以下の方法で出力できます。
- List Managerの帳票一覧画面から出力する
- List Managerの帳票ブラウザの出力指示画面から出力する
- 帳票の出力/出力中止コマンド（lmoprprintコマンド）を使用して出力する
- 帳票管理Javaインタフェースを使用して出力する
このキーで「NONE」（登録のみ行う）を指定した場合、帳票の総ページ数が表示/取得されないことがあります。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

ID_LM_KEEPFORMMODE（帳票出力後の保存指定）

List Managerで帳票を出力後、保存するかどうかを指定します。

このキーは、帳票配信用の論理あて先に出力する場合のみ有効になります。

NONE：: 保存しません。

DO：: 保存します。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

論理あて先の編集コマンド（lmedtldコマンド）で設定した帳票出力後の保存指定
帳票属性の編集コマンド（lmedtformatrコマンド）で設定した帳票出力後の保存指定

注意

Web手元印刷型の場合、このキーは無効となり、必ず帳票出力後に帳票が保存されます。したがって、保存日数はID_LM_TERMキーで指定することができます。
このキーで「NONE」を指定した場合、帳票の出力が完了した時点で削除されます。

ID_LM_TERM（保存日数の指定）

List Managerで帳票を保存する日数を以下の範囲で指定します。

0：: 帳票を無期限に保存します。

1～9999：: 帳票を保存する日数を指定します。

このキーは、帳票出力後の保存指定で「DO」（保存する）を指定した場合のみ有効となります。

Web手元印刷型の場合、帳票出力後の保存指定は無効となりますが、「DO」（保存する）が指定されたものとみなされるため、保存日数の指定は有効になります。

帳票出力後の保存指定は、以下のいずれかの方法で指定します。

ID_LM_KEEPFORMMODEキー
帳票属性の編集コマンド（lmedtformatrコマンド）
論理あて先の編集コマンド（lmedtldコマンド）

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

論理あて先の編集コマンド（lmedtldコマンド）で設定した保存日数の指定
帳票属性の編集コマンド（lmedtformatrコマンド）で設定した保存日数の指定

ポイント

帳票の保存期限は、「保存期限＝作成日＋保存日数－１」で計算されます。保存日数に「１」を指定した場合は、「保存期限＝作成日」となります。
保存期限が設定された帳票を削除する場合は、保存期限を経過した帳票の削除コマンド（lmdelexpireコマンド）を使用してください。

ID_LM_OPRIDINFO（業務あて先名）

出力する帳票の業務あて先名を256バイト以内で指定します。

業務あて先とは、ユーザ（個人）またはユーザグループ（組織など）を識別するための情報です。

List Managerの帳票ブラウザを利用して、帳票を管理・操作する場合は、必ず指定してください。

帳票ブラウザでは、業務あて先ごとに帳票を一覧表示するため、論理あて先の異なる帳票であっても業務あて先単位にまとめて操作する（帳票の出力指示、出力状況確認など）ことができます。

業務あて先名は、以下のように指定します。

ユーザを業務あて先とする場合
「UユーザID」の形式で指定します。ユーザIDは、ユーザ情報の編集コマンド（lmedtusrコマンド）で定義したユーザIDを指定します。
ユーザグループを業務あて先とする場合
「GユーザグループID」の形式で指定します。ユーザグループIDは、ユーザグループ情報の編集コマンド（lmedtusrgrpコマンド）で定義したユーザグループIDを指定します。

このキーの呼び出しを省略すると、出力する帳票を帳票ブラウザから利用することはできません。

注意

帳票管理サーバがWindowsの場合、業務あて先に指定するユーザIDおよびユーザグループIDに含まれる英字は、小文字で指定してください。

ポイント

List Managerに登録されているユーザID、ユーザグループIDは、ユーザ情報の編集コマンド（lmedtusrコマンド）、ユーザグループ情報の編集コマンド（lmedtusrgrpコマンド）で確認できます。
業務あて先名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_LM_INFOFILE（List Manager管理情報ファイル名）

List Manager管理情報ファイル名を、以下の範囲で指定します。

帳票管理サーバがWindowsの場合
250バイト以内のフルパスで指定します。
帳票管理サーバがSolaris/Linuxの場合
1023バイト以内のフルパスで指定します。

List Manager管理情報ファイルとは、登録する帳票の拡張情報として「カスタマイズ項目」を指定するファイルです。

List Manager管理情報ファイルの詳細については、以下を参照してください。
⇒“7.2 List Manager管理情報ファイル”

このキーの呼び出しを省略すると、帳票の拡張情報は設定されません。

注意

List Manager管理情報ファイル中のデータは、必ず以下の文字コード系で記述してください。
- 帳票管理サーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- 帳票管理サーバがSolaris/Linuxの場合
  環境変数LANGで指定した文字コード系で記述してください。
  ただし、環境変数LANGにEUCコード系を指定した場合、標準のEUCで記述してください。
List Creatorコネクタ連携時に、List Manager 管理情報ファイルを転送する場合（アプリケーションサーバに配置した場合）、List Manager管理情報ファイル名は、このキーとID_LCFILE キーの両方で指定してください。その場合、このキーにはファイル名のみ指定してください。

ポイント

List Manager管理情報ファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

●ユーザ資源情報に関するキー

ID_BARCODEDATA（バーコードデータのBASE64エンコード指定）

バーコードCODE128、EAN-128の入力データのエンコード方法を指定します。

NONE：: CODE128、EAN-128の入力データにエンコードしないデータを指定します。

BASE64：: CODE128、EAN-128の入力データにBASE64エンコードしたデータを指定します。

このキーの呼び出しを省略すると、「NONE」が指定されたものとして動作します。

注意

このキーを指定する場合は、帳票設計時に対象となるバーコード項目
（CODE128、EAN-128）に、以下の設定をしてください。
- 対象となるバーコード項目のプロパティの［プロパティ］タブの項目長
```
          BASE64エンコードする前のバーコードデータの長さに+2した長さ
```
- List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目のバイト数（入力データ形式が「固定長」の場合）
```
          BASE64エンコードした後のバイト数
```
以下の場合、このキーに「BASE64」を指定しないでください。
- List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブの該当するデータ項目にオペランドを指定した場合
- List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのオペランドに該当するデータ項目名を指定した場合
- List Creatorデザイナのデータ定義画面の［拡張定義］タブに該当するデータ項目名を指定した場合

ID_VISUALDIR（メディアデータ格納ディレクトリ）

メディアデータ格納ディレクトリを以下の範囲で指定します。

帳票配信型の場合（帳票出力サーバのフルパス）
250バイト以内で指定します。
Web手元印刷型（PDFファイル形式）の場合（帳票管理サーバのフルパス）
- 帳票管理サーバがWindowsの場合
  250バイト以内で指定します。
- 帳票管理サーバがSolaris/Linuxの場合
  512バイト以内で指定します。

また、List Creatorコネクタ連携時のメディアデータ格納ディレクトリについても、上記の範囲で指定します。

このキーで指定するディレクトリパスは、帳票出力先の環境で有効となります。

組込みメディア項目のデータがファイル名のみの場合、このキーで指定したメディアデータ格納ディレクトリ配下を検索します。

複数のメディアデータ格納ディレクトリを指定する場合は、ディレクトリ名を「セミコロン（;）」で区切って指定します。

指定した複数のディレクトリ配下に同一名のメディアデータがある場合は、先に指定したディレクトリ配下のメディアデータが有効になります。

このキーの呼び出しを省略した場合、またはここで指定したディレクトリ配下にメディアデータが見つからない場合は、以下のディレクトリが有効になります。

帳票配信型の場合
帳票出力サーバの環境設定ファイルのLmlcMediaDirキーで指定したディレクトリ
Web手元印刷型（PDFファイル形式）の場合
帳票管理サーバの環境設定ファイルのLmlcMediaDirキーで指定したディレクトリ

注意

帳票一覧画面、または帳票ブラウザで、組込みメディア項目が定義された帳票をプレビューする場合、必ずID_CMVISUALFILEキーでメディアデータファイル名を指定してください。
Web手元印刷型（OWFファイル形式）の場合、このキーは無効になります。ID_CMVISUALFILEキーで指定してください。
このキーによる指定よりも、ID_CMVISUALFILEキーで指定したメディアデータファイル名の方が優先されます。
帳票配信型の場合、メディアデータ格納ディレクトリ名の末尾には、「円マーク（\）」を指定しないでください。
Web手元印刷型（PDFファイル形式）の場合、メディアデータ格納ディレクトリ名の末尾には、以下を指定しないでください。
- 帳票管理サーバがWindowsの場合
  「円マーク（¥）」
- 帳票管理サーバがSolaris/Linuxの場合
  「スラッシュ（/）」
帳票管理サーバがWindowsの場合、メディアデータ格納ディレクトリとして、ネットワークドライブ（UNC 指定（¥¥コンピュータ名¥共有名¥ディレクトリ名）を除く）、およびリムーバブルディスクを指定しないでください。

ID_CMVISUALFILE（メディアデータファイル名）

帳票管理サーバのメディアデータファイル名をフルパスで指定します。

複数のファイルを使用する場合は、以下のように「セミコロン（;）」で区切って、帳票を出力する順に指定します。

    ファイル名1;ファイル名2;ファイル名3

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

帳票配信型の場合

ID_VISUALDIRキーで指定した帳票出力サーバのディレクトリにあるメディアデータファイル名
帳票出力サーバの環境設定ファイルのLmlcMediaDirキーで指定したディレクトリにあるメディアデータファイル名

Web手元印刷型（PDFファイル形式）の場合

ID_VISUALDIRキーで指定した帳票管理サーバのディレクトリにあるメディアデータファイル名
帳票管理サーバの環境設定ファイルのLmlcMediaDirキーで指定したディレクトリにあるメディアデータファイル名

注意

組込みメディア項目に対する入力データ中のメディアデータファイル名は、ファイル名のみ指定してください。
以下の場合、このキーは省略できません。
- 帳票一覧画面および帳票ブラウザで、組込みメディア項目が定義された帳票をプレビューする場合
- Web手元印刷型（OWFファイル形式）でメディアデータを使用する場合

●識別情報に関するキー

ID_TITLE（タイトル）

タイトルを64バイト以内で指定します。

このキーの呼び出しを省略すると、帳票名（組合せフォーム出力時は、setLcFormメソッドで指定した先頭の帳票名）が帳票のタイトルになります。

注意

PDFファイル保存する場合、タイトルは、日本語（JIS 非漢字/ 第一水準漢字/第二水準漢字）または英数字で指定してください。その他の文字を指定した場合、PDFファイルの文書情報（一般）で正しく表示されないことがあります。
環境変数LANGおよびList Manager管理データベースの文字コード系によって、実際に指定したバイト数よりList Manager管理データベースに登録される文字列のバイト数が短くなることがあります。詳細については、以下を参照してください。
⇒“C.1 List Managerで扱える文字コード系”

ポイント

タイトルに指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_COMMENT（コメント）

帳票に関するコメントを64バイト以内で指定します。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

帳票属性の編集コマンド（lmedtformatrコマンド）で指定したコメント
設定されない

なお、組合せフォーム出力する場合は、以下の優先順序で有効になります。

帳票属性の編集コマンド（lmedtformatr コマンド）で指定したコメント
組合せフォーム定義で指定したコメント
設定されない

注意

以下の場合、このキーは無効となります。

PDFファイル保存する場合

参考

環境変数LANGおよびList Manager管理データベースの文字コード系によって、実際に指定したバイト数よりList Manager管理データベースに登録される文字列のバイト数が短くなることがあります。詳細については、以下を参照してください。
⇒“C.1 List Managerで扱える文字コード系”

ポイント

コメントに指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_USERID（出力ユーザ）

帳票を出力したユーザを識別するために、帳票に出力するユーザの識別名（任意の文字列）を指定します。

指定した出力ユーザは、帳票定義情報に定義されている項目のうち、USERID演算子が指定されているデータ項目に出力されます。

指定する出力ユーザは、ユーザを出力するデータ項目の項目長に収まるバイト数以内で指定してください。

なお、実際に帳票に出力されるユーザは、帳票の登録後に帳票がどのように出力されるかによって決まります。

帳票登録後にそのまま続けて出力する場合
このキーで指定した出力ユーザが出力されます。
帳票登録後にそのまま続けて出力しない場合
（帳票の登録後にList Managerの各画面や運用コマンドなどを利用して、出力および再出力などの操作を行う場合）
帳票管理サーバの環境設定ファイルのOutputUserInfoキーの設定にしたがい出力されます。

このキーの呼び出しを省略すると、帳票管理サーバの環境設定ファイルのOutputUserInfoキーの指定にしたがいます。

ポイント

出力ユーザに指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

●動作情報に関するキー

ID_STARTPAGE（開始ページ番号）

出力を開始するページ番号を指定します。

マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）は、全帳票を通してのページ番号を指定します。

帳票の総ページ数以下の値、および終了ページ番号（ID_ENDPAGEキー）以下の値を指定してください。

このキーの呼び出しを省略すると、1ページ目から出力を開始します。

ポイント

このキーを指定した場合、以下に表示される帳票の総ページ数は指定した範囲のページ数となります。

List Managerの帳票一覧画面
List Managerの詳細表示画面
List Managerの帳票ブラウザの帳票詳細表示画面
帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
帳票管理Javaインタフェースでの取得結果

帳票のページ数については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

ID_ENDPAGE（終了ページ番号）

出力を終了するページ番号を指定します。

帳票の総ページ数より大きな値を指定した場合、帳票の最終ページまで出力されます。

開始ページ番号（ID_STARTPAGEキー）以上の値を指定してください。

このキーの呼び出しを省略すると、最終ページまで出力します。

ポイント

このキーを指定した場合、以下に表示される帳票の総ページ数は指定した範囲のページ数となります。

List Managerの帳票一覧画面
List Managerの詳細表示画面
List Managerの帳票ブラウザの帳票詳細表示画面
帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
帳票管理Javaインタフェースでの取得結果

帳票のページ数については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

ID_DIRECTMETHOD（出力方法）: このキーは未サポートです。

ID_OUTPUTMODE（出力方法）: このキーは未サポートです。

ID_REPLACESTRING（SET演算子の置換文字列）

SET演算子の置換文字列を指定します。

List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目のオペランドでSET演算子に変数「%」を指定した場合に、「%」の置換文字列を指定します。［データ定義（レポート頭書き）］タブのデータ項目用の置換文字列に続けて［データ定義］タブのデータ項目用の置換文字列を指定します。

SET演算子に変数「%」を指定した場合は、このキーで置換文字列を必ず指定してください。置換文字列の指定形式については、以下を参照してください。
⇒List Creatorのオンラインマニュアル“環境設定・帳票運用編”

ポイント

マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）/組合せフォーム出力（FormsFile クラス、FormsStream クラスのsetCbForm メソッドに「true」を指定した場合）する場合は、使用するすべての帳票に対してこのキーで指定した同じ置換文字列が有効になります。

ID_OUTPUTSCALE（用紙サイズに合わせた拡大/縮小）

指定した用紙サイズに合わせて帳票を拡大または縮小して出力したい場合に、出力したい用紙サイズを指定します。

指定された用紙サイズが定義された用紙サイズよりも大きい場合は、指定された用紙サイズに拡大されます。指定された用紙サイズが定義された用紙サイズよりも小さい場合は、指定された用紙サイズに縮小されます。

なお、拡大または縮小を行った場合、横幅と縦幅の比率は保たれます。

A3：: A3用紙

A4：: A4用紙

A5：: A5用紙

A6：: A6用紙

B4：: B4用紙

B5：: B5用紙

PS：: はがき

LT：: Letter

LG：: Legal

用紙サイズに合わせた拡大/縮小指定は、以下の優先順序で有効になります。

プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定した用紙サイズ
このキーで指定した用紙サイズ
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブの拡大/縮小指定

注意

以下の場合、用紙サイズのみ有効になり、拡大/縮小指定は無効になります。
- 拡大/縮小がサポートされていないプリンタを使用した場合
このオプションは、出力方法が印刷、PDF ファイル保存の場合、および電子保存した帳票を印刷する場合のみ有効になります。電子保存した帳票を表示する場合は無効になります。
電子保存は、Interstage List Manager互換のための機能です。

ID_STARTPOSITIONGRIDUNIT（原点位置指定時の単位）

帳票出力時の原点位置を指定する場合の単位を指定します。

INCH：: インチ単位で指定します。

MM：: ミリ単位で指定します。

原点位置指定時の単位は、以下の優先順序で有効になります。

論理デバイスの編集コマンド（lmedtdevコマンド）で指定した原点位置指定単位
このキーで指定した原点位置指定時の単位
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［余白］タブで指定した原点位置

注意

このオプションは、出力方法が印刷、PDF ファイル保存の場合、および電子保存した帳票を印刷する場合のみ有効になります。電子保存した帳票を表示する場合は無効になります。
電子保存は、Interstage List Manager互換のための機能です。
このキーを指定する場合、ID_STARTPOSITIONXキーおよびID_STARTPOSITIONYキーで原点位置を必ず指定してください。
ID_STARTPOSITIONXキー、およびID_STARTPOSITIONYキーを指定する場合、このキーで単位を必ず指定してください。このキーの呼び出しを省略した場合、ID_STARTPOSITIONXキー、およびID_STARTPOSITIONYキーを指定しても無効になります。

ID_STARTPOSITIONX（原点位置指定（印刷時開始時の横方向位置））

印刷開始時の横方向の位置を指定します。

0.00～22.50：: インチ単位指定の場合

0.0～571.5：: ミリ単位指定の場合

原点位置指定（印刷開始時の横方向位置）は、以下の優先順序で有効になります。

論理デバイスの編集コマンド（lmedtdevコマンド）で指定した原点位置
このキーで指定した原点位置
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［余白］タブで指定した原点位置

注意

このオプションは、出力方法が印刷、PDF ファイル保存の場合、および電子保存した帳票を印刷する場合のみ有効になります。電子保存した帳票を表示する場合は無効になります。
電子保存は、Interstage List Manager互換のための機能です。
このキーを指定する場合、 ID_STARTPOSITIONGRIDUNITキーで単位を必ず指定してください。
ID_STARTPOSITIONGRIDUNITキーの呼び出しを省略した場合、このキーを指定しても無効になります。
このキーを指定する場合、ID_STARTPOSITIONYキーで印刷開始時の縦方向位置を必ず指定してください。

ID_STARTPOSITIONY（原点位置指定（印刷時開始時の縦方向位置））

印刷開始時の縦方向の位置を指定します。

0.00～22.50：: インチ単位指定の場合

0.0～571.5：: ミリ単位指定の場合

原点位置指定（印刷開始時の縦方向位置）以下の優先順序で有効になります。

論理デバイスの編集コマンド（lmedtdevコマンド）で指定した原点位置
このキーで指定した原点位置
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［余白］タブで指定した原点位置

注意

このオプションは、出力方法が印刷、PDF ファイル保存の場合、および電子保存した帳票を印刷する場合のみ有効になります。電子保存した帳票を表示する場合は無効になります。
電子保存は、Interstage List Manager互換のための機能です。
このキーを指定する場合、 ID_STARTPOSITIONGRIDUNITキーで単位を必ず指定してください。
ID_STARTPOSITIONGRIDUNITキーの呼び出しを省略した場合、このキーを指定しても無効になります。
このキーを指定する場合、ID_STARTPOSITIONXキーで印刷開始時の横方向位置を必ず指定してください。

ID_LFCODE（改行コード制御指定）

入力データ形式が「可変長」、「固定長」、または「CSV形式」で、入力データ中に改行コードのみの行が存在した場合の制御方法を指定します。

SKIP：: 改行コードのみの行は読み飛ばします。改行コードがなかったものとして動作します。

DO：: 改行コードのみの行は改行処理だけを行います。空の1行が出力されます。

このキーの呼び出しを省略すると、「SKIP」が指定されたものとして動作します。

注意

このキーは、入力データ形式が「可変長」、「固定長」、および「CSV形式」の場合に有効です。「XML形式」の場合はエラーになります。
このキーは、以下の帳票形式を使用する際のキーです。
- フリーフレーム形式
- 集計表形式
- 伝票形式
- 矩形繰返し形式
- タックシール形式
カード形式の場合、このキーで「DO」（改行コードのみの行は改行処理だけを行う指定）を指定しないでください。指定した場合、入力データが出力されない空ページが出力されることになります。
このキーで「DO」（改行コードのみの行は改行処理だけを行う指定）を指定した場合、List Creatorデザイナのデータ定義画面の［データ定義］タブのデータ項目のオペランドに「BREAK」を指定すると、意図しない動作（データのある行と改行コードのみの行でBREAKが発生したことになる）になります。

ポイント

改行コードは、以下のとおりです。

帳票管理サーバがWindowsの場合
0x0D0Aまたは0x0A
帳票管理サーバがSolaris/Linuxの場合
0x0A

ID_FFCODE（改ページコード制御指定）

入力データ形式が「可変長」、「固定長」、または「CSV形式」の場合、入力データ中の改ページコードの制御方法を指定します。

SKIP：: 改ページ処理を行わず、改ページコードは読み飛ばします。
改ページコードがなかったものとして動作します。

DO：: 改ページ処理を行います（次のレコードは次ページより出力します）。

NONE：: 改ページ処理および改ページコードの読み飛ばしを行いません。改ページコードを意識せずに入力データの読み込みを行うため、改ページコードが含まれると、不当な文字が出力されることがあります。

このキーの呼び出しを省略すると、「NONE」が指定されたものとして動作します。

注意

このキーは、入力データ形式が「可変長」、「固定長」、および「CSV形式」の場合に有効です。「XML形式」の場合はエラーになります。
このキーは、以下の帳票形式を使用する際のキーです。
- フリーフレーム形式
- 集計表形式
- 伝票形式
- 矩形繰返し形式
- タックシール形式
カード形式の場合、このキーで「DO」（改ページ処理を行う指定）を指定しないでください。指定した場合、入力データが出力されない空ページが出力されることになります。カード形式で改ページコードを含んだ入力データを使用する場合は、このキーで「SKIP」を指定してください。

ポイント

改ページコードの前には、改行コードは、あってもなくても構いません。
改ページコードは、以下のとおりです。
- 帳票管理サーバがWindowsの場合
  0x0D0Cまたは0x0C
- 帳票管理サーバがSolaris/Linuxの場合
  0x0C
改行コードは、以下のとおりです。
- 帳票管理サーバがWindowsの場合
  0x0D0Aまたは0x0A
- 帳票管理サーバがSolaris/Linuxの場合
  0x0A

ID_NODATA（入力データにデータがない場合の動作指定）

入力データ（項目）が0バイトの場合に、エラーとなるかどうかを指定します。

false：: エラーとします。

true：

エラーとせず出力します。

「true」を指定した場合、入力データ（項目）が0バイトの場合もエラーになりません。

その場合、0バイトの項目は、以下のように出力されます。

テキスト項目：: 出力されません（空白になります）。

数字項目：: 0が出力されます。

OCR-B項目：: 出力されません（空白になります）。

ラジオボタン項目：: 選択されません。

チェックボックス項目：: 選択されません。

バーコード項目：: 出力されません（空白になります）。

組込みメディア項目：: 出力されません（空白になります）。

郵便番号項目：: 出力されません（空白になります）。

矩形テキスト項目：: 出力されません（空白になります）。

このキーの呼び出しを省略した場合、または上記（「true」、「false」）以外の値を指定した場合、「false」が指定されたものとして動作します。

注意

入力データ形式が「XML形式」の場合、このキーは指定しないでください。

ポイント

入力データ（項目）が0バイトでない場合の動作は、以下のとおりです。
- 「false」を指定した場合
  数字項目以外は、このキーで「true」を指定した場合と同じ出力動作となります。数字項目は、空白となります。
- 「true」を指定した場合
  このキーの出力と同じ出力動作になります。
マルチフォーム出力/組合せフォーム出力時、入力データ（項目）が0バイトの状態とは、以下の条件をすべて満たす状態を指します。
- 帳票名およびマルチフォーム/組合せフォーム用帳票名データ区切り文字が記述されている
- レコードには帳票名に続くデータが存在しない
- 同一の帳票名に対してレコードが連続していない
レコードが連続している場合は、入力データにレコードが存在すると判断するため、このキーの動作指定は1レコード目にのみ有効になりますが、以降のレコードは通常の帳票出力時の印刷動作になります。

ID_LABELDATA（項目名ラベル付きデータ指定）

入力データを「項目名ラベル付きデータ」として扱うかどうかを指定します。

false：: 入力データを項目名ラベル付きデータとして扱いません。

true：: 入力データを項目名ラベル付きデータとして扱います。

このキーの呼び出しを省略すると、「false」が指定されたものとして動作します。

注意

入力データ形式が「固定長」または「XML形式」の場合、このキーに「true」を指定しないでください。

ポイント

項目名ラベル付きデータの詳細については、List Creatorデザイナに添付のオンラインマニュアルを参照してください。

ID_MAPFONTFILE（置換フォント情報ファイル名）

帳票出力時に使用する置換フォント情報ファイル名を以下の範囲で指定します。

帳票管理サーバがWindowsの場合
250バイト以内のフルパスで指定します。
帳票管理サーバがSolaris/Linuxの場合
1023バイト以内のフルパスで指定します。

置換フォント情報ファイルとは、帳票定義情報に定義されているフォントを帳票出力時に別のフォントに置き換えて出力する場合に、その置き換え情報を指定するファイルです。

置換フォント情報ファイルについては、以下を参照してください。

⇒“7.1.1 置換フォント情報ファイル”

このキーの呼び出しを省略すると、置換フォント情報ファイルは設定されません。

注意

このキーで指定する置換フォント情報ファイル中のデータは、以下の文字コード系で記述してください。
- 帳票管理サーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- 帳票管理サーバがSolaris/Linuxの場合
  以下のいずれかの文字コード系で記述してください。
```
      － setFileTypeメソッドで指定した文字コード系
```
```
      － 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系
```
  なお、文字コード系の指定は、以下の優先順序で有効になります。
```
      1. setFileTypeメソッド
```
```
      2. 環境変数LANGおよび環境変数OA_EUCTYPE
```
なお、List Creatorコネクタ連携時の置換フォント情報ファイルの文字コード系については、オンラインマニュアル“帳票印刷配信機能運用ガイド”を参照してください。
List Creatorコネクタ連携時に、置換フォント情報ファイルを転送する場合（アプリケーションサーバに配置した場合）、置換フォント情報ファイル名は、このキーとID_LCFILE キーの両方で指定してください。その場合、このキーにはファイル名のみ指定してください。

ポイント

置換フォント情報ファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_BCODADJUST（バーコード補正情報ファイル名）

帳票出力時に使用するバーコード補正情報ファイル名を1023バイト以内のフルパスで指定します。

バーコード補正情報ファイルとは、帳票にバーコードを出力する場合に、出力先の環境に合わせてバーコードの出力結果を補正する情報を指定するファイルです。

バーコード補正情報ファイルについては、以下を参照してください。
⇒“7.1.2 バーコード補正情報ファイル”

このキーの呼び出しを省略すると、帳票管理サーバの環境設定ファイルのLmBarcodeAdjustキーの指定にしたがいます。

注意

このキーで指定するバーコード補正情報ファイル中のデータは、必ず以下の文字コード系で記述してください。
- 帳票管理サーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- 帳票管理サーバがSolaris/Linuxの場合
  以下のいずれかの文字コード系で記述してください。
```
      － setFileTypeメソッドで指定した文字コード系
```
```
      － 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系
```
  なお、文字コード系の指定は、以下の優先順序で有効になります。
```
      1. setFileTypeメソッド
```
```
      2. 環境変数LANGおよび環境変数OA_EUCTYPE
```
List Creatorコネクタ連携時に、バーコード補正情報ファイルを転送する場合（アプリケーションサーバに配置した場合）、バーコード補正情報ファイル名は、このキーとID_LCFILE キーの両方で指定してください。その場合、このキーにはファイル名のみ指定してください。

ポイント

バーコード補正情報ファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_PRINTENVFILE（帳票出力情報ファイル名）

帳票出力時に使用する帳票出力情報ファイル名をフルパスで指定します。

帳票出力情報ファイルとは、帳票出力に関する各種情報を定義するファイルです。

帳票出力情報ファイルについては、以下を参照してください。

⇒“7.1.6 帳票出力情報ファイル”

注意

帳票出力情報ファイルの文字コード系については、List Creatorのオンラインマニュアル“環境設定・帳票運用編”の情報ファイルの文字コード系についての記載を参照してください。
以下の場合、このキーにファイル名のみ指定してください。
- コネクタ連携時に帳票出力情報ファイルを転送した場合

●印刷情報に関するキー

ID_PRTDEVNAME（印刷機種名）: このキーは未サポートです。

ID_PRINTER（印刷プリンタ名）: このキーは未サポートです。

ID_PRINTBIN（給紙方法）: このキーは未サポートです。

ID_PRINTBINNAME（給紙口名）: このキーは未サポートです。

ID_ITEMPRINTBIN（給紙方法/給紙口名切り替え指定）

用紙種別が「単票」で、マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）、帳票を切り替えたときに給紙方法/給紙口名も切り替える（各帳票で指定した給紙方法/給紙口名を有効にする）かどうかを指定します。

!REPORT：: 各帳票で指定した給紙方法/給紙口名を有効にします。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定した給紙口名
List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した給紙方法/給紙口名

注意

指定した給紙方法で給紙されない場合は、給紙口名をList Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定し、このキーを指定してください。
プリンタの段組み印刷機能を使用する場合、このキーを指定しないでください。指定した場合、正しく動作しません。
プリンタによっては、帳票ごとに給紙方法/給紙口名を切り替えられないものもあります。必ず、実際に使用するプリンタで動作確認してください。

ID_COPYNUMBER（印刷部数）

帳票の印刷部数を1～999の範囲で指定します。

ページ単位で指定した部数分が印刷されます。指定した部数分を部単位で印刷する場合は、部単位印刷（ID_COPYNUMBERCOLLATEキー）を指定してください。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した印刷部数と部単位印刷の指定が有効になります。

注意

帳票をページ単位で印刷する場合と部単位で印刷する場合では、出力結果が異なります。
例として、2ページの帳票を3部印刷するときの、このキーの指定方法と出力結果について、以下の場合ごとに示します。

部単位で印刷しない場合（ページ単位で印刷する場合）

指定方法
    setProperty( PrintProperties.ID_COPYNUMBER, "3" );
出力結果
    (1)(1)(2)(2)(2)
      (1)：帳票の1ページ目
      (2)：帳票の2ページ目

部単位で印刷する場合

指定方法
    setProperty( PrintProperties.ID_COPYNUMBER, "3" );
    setProperty( PrintProperties.ID_COPYNUMBERCOLLATE, "true" );
出力結果
    (1)(2)(1)(2)(1)(2) 
      (1)：帳票の1ページ目
      (2)：帳票の2ページ目

プリンタドライバのプロパティで印刷部数が指定できないプリンタに出力する場合、以下のように動作します。
- 部単位で印刷する指定をしないとき（ID_COPYNUMBERCOLLATEキーの指定を省略したとき、または「false」を指定したとき）、印刷部数を指定していても無効になります（1部だけ印刷されます）。
- 部単位で印刷する指定をしたとき（ID_COPYNUMBERCOLLATEキーに「true」を指定したとき）、印刷部数の指定は有効になります。
List Creatorデザイナの帳票業務情報のプロパティ画面で指定された部数は、以下では表示されません。
- List Managerの詳細表示画面
- 帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
- 帳票管理Javaインタフェースでの取得結果
このキーで印刷部数を指定した場合、帳票のページ数について注意が必要です。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

ID_COPYNUMBERCOLLATE（部単位で印刷）

ID_COPYNUMBERキーで印刷部数を指定した場合、部単位で印刷するかどうかを指定します。

true：: 部単位で印刷します。

false：: 部単位で印刷しません。

印刷部数（ID_COPYNUMBERキー）を指定し、このキーの呼び出しを省略すると、「false」が指定されたものとして動作します。

印刷部数（ID_COPYNUMBERキー）を指定し、このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

印刷部数（ID_COPYNUMBERキー）、およびこのキーの両方の呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した印刷部数と部単位印刷の指定が有効になります。

注意

このキーは、以下の場合に有効です。
- List Works Print Agentで印刷する場合
- List Works Workstationで、出力装置にPrint Managerで定義したプリンタを指定した場合
プリンタドライバのプロパティで印刷部数が指定できないプリンタに出力する場合、以下のように動作します。
- 部単位で印刷する指定をしないとき（このキーの指定を省略したとき、または「false」を指定したとき）、印刷部数を指定していても無効になります（1部だけ印刷されます）。
- 部単位で印刷する指定をしたとき（このキーに「true」を指定したとき）、印刷部数の指定は有効になります。
List Works Workstationで、印刷プリンタ名にPrint Managerで定義したプリンタ以外を指定した場合は、このキーに「true」を指定しないでください。指定した場合、印刷部数の指定は無効になります（1部だけ印刷されます）。

ID_PRINTSIDE（印刷面指定）

以下について指定します。

両面印刷するかどうか、またはプリンタ装置（プリンタドライバ）の印刷面の設定にしたがうか
マルチフォーム出力する場合に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか

SINGLEFOLLOW：: 片面印刷します。
マルチフォーム出力をする場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

BOTHFOLLOW：: 両面印刷します。
マルチフォーム出力をする場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

PRTFOLLOW：: プリンタ装置（プリンタドライバ）の印刷面の設定にしたがって印刷します。
マルチフォーム出力をする場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

SINGLE：: 片面印刷します。
マルチフォーム出力をする場合は、帳票を切り替えたときに新しい用紙に印刷します。

BOTH：: 両面印刷します。
マルチフォーム出力をする場合は、帳票を切り替えたときに新しい用紙に印刷します。

PRT：: プリンタ装置（プリンタドライバ）の印刷面の設定にしたがって印刷します。
マルチフォーム出力をする場合は、帳票を切り替えたときに新しい用紙に印刷します。

なお、印刷面指定は、以下の優先順序で有効になります。

ID_ITEMPRINTSIDEキーの指定にしたがった両面印刷と、マルチフォーム出力時に帳票を切り替えたときに新しい用紙に印刷する指定
このキーで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

注意

使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
以下の場合、このキーに「SINGLE」、「BOTH」または「PRT」を指定しないでください。指定した場合、正しく動作しません。
- プリンタの段組み印刷機能を使用する場合
- プリンタの白紙の出力を抑止する機能を使用する場合
このキーで印刷面を指定した場合、帳票のページ数について注意が必要です。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

ポイント

List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目にPAGE 、TPAGE 、PAGE-ALL 、TPAGE-ALL 、BPAGE、またはBTPAGE のいずれかを指定した項目が存在する帳票で、このキーに「SINGLE」、「BOTH」または「PRT」を指定する場合、印刷せずにページ送りされた分はカウントされません。

ID_ITEMPRINTSIDE（印刷面切り替え指定）

マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）で、帳票を切り替えたときに印刷面も切り替える（各帳票で指定した印刷面指定を有効にする）かどうかを指定します。

!REPORT：: 各帳票で指定した印刷面指定を有効にします。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

ID_PRINTSIDEキーで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

注意

使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
プリンタの段組み印刷機能を使用する場合、このキーを指定しないでください。指定した場合、正しく動作しません。
プリンタによっては、帳票ごとに印刷面を切り替えられないものもあります。必ず実際に使用するプリンタで動作確認してください。
このキーで印刷面切り替えを指定した場合、帳票のページ数について注意が必要です。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

ID_PAPERCODE（用紙コード（用紙名））: このキーは未サポートです。

●電子保存情報に関するキー

注意

電子保存情報に関するキー、およびList Creatorデザイナの帳票業務情報のプロパティ画面で指定された電子保存情報は、以下では表示されません。

List Managerの帳票一覧画面
List Managerの詳細表示画面
List Managerの帳票ブラウザの帳票詳細表示画面
帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
帳票管理Javaインタフェースでの取得結果

ポイント

電子保存情報に関するキーは、Interstage List Manager互換のための機能で使用するキーです。

ID_LW_DRVNAME（電子保存装置名）: このキーは未サポートです。

ID_LW_MAKER（電子保存時の作成者）

帳票の作成者を64バイト以内で指定します。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブで指定した作成者
設定されない

ID_LW_GENERATEDAY（電子保存時の作成日）

帳票の作成日付を指定します。

作成日付は「YYYYMMDD」（YYYY：西暦、MM：月（01～12）、DD：日（01～31））の形式で指定してください。作成日と作成時間の指定の関係については、以下を参照してください。
⇒“B.1 電子保存時の作成日時”

ID_LW_GENERATETIME（電子保存時の作成時間）

帳票の作成時間を指定します。

作成時間は「HHmm」（HH：時（00～23）、mm：分（00～59））の形式で指定してください。作成日と作成時間の指定の関係については、以下を参照してください。
⇒“B.1 電子保存時の作成日時”

ID_LW_KEEPDIR（電子保存時の保管フォルダパス名）

帳票を電子保存するリスト管理サーバ上の保管フォルダのディレクトリ名を185バイト以内のフルパスで指定します。List Worksの「保管フォルダ名」ではなく、システムにおけるディレクトリ名で指定します。

以下の半角文字は指定しないでください。

「/」、「,」、「;」、「*」、「?」、「"」、「<」、「>」、「|」

このキーの呼び出しを省略すると、論理デバイスの編集コマンド（lmedtdev コマンド）で指定した保管フォルダパス名が有効になります。

注意

保管フォルダパス名の末尾には、以下を指定しないでください。
```
「円マーク（\）」
```
以下のいずれかに保管フォルダが指定されていた場合、指定した場所に帳票が電子保存されるため、List Worksで指定した振り分け条件が無効になります。
- ID_LW_KEEPDIRキー
- 論理デバイスの編集コマンド（lmedtdevコマンド）
List Worksの振り分け条件を有効にしたい場合は、上記の保管フォルダの指定をすべて省略する必要があります。

ID_LW_NOTE1（電子保存時の備考1）

ID_LW_NOTE2（電子保存時の備考2）

ID_LW_NOTE3（電子保存時の備考3）

ID_LW_NOTE4（電子保存時の備考4）

帳票の備考1～4を64バイト以内で指定します。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した備考1～4
設定されない

ID_LW_TERM（電子保存時の有効期限日数）

帳票をリスト管理サーバに登録した日からの有効期限日数を0～9999の範囲で指定します。

0：: リスト管理サーバの保管フォルダの設定にしたがいます。

1～9999：: 有効期限日数を指定します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した有効期限日数が有効になります。

ID_LW_DELTYPE（電子保存時の有効期限経過後の自動削除指定）

帳票をリスト管理サーバに登録した日から有効期限を過ぎた場合に、リストクリーナの削除対象とするかどうかを指定します。

true：: 削除対象とします。

false：: 削除対象としません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した有効期限の「有効期限を過ぎたら自動削除する」の指定が有効になります。

注意

このキーを指定する場合は、以下のいずれかで有効期限日数を指定しておく必要があります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面の有効期限の日数
ID_LW_TERMキー

ID_LW_SEARCH（電子保存時の抜き出し検索指定）

電子保存時に帳票の抜き出し検索を有効にするかどうかを指定します。

FOLDER：: リスト管理サーバの保管フォルダの設定にしたがいます。

FALSE：: 抜き出し検索を有効にしません。

TRUE：: 抜き出し検索を有効にします。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した抜き出し検索の指定が有効になります。

注意

抜き出し検索を有効にする場合は、あらかじめリスト管理サーバに登録されている帳票で抜き出し検索範囲を指定しておく必要があります。

ポイント

抜き出し検索とは、あらかじめ設定されている検索範囲（抜き出し検索範囲）に対して、文字列を高速に検索する機能です。定型的な検索を大量に行う場合に適しています。
List Worksでは、電子保存した帳票のデータを検索できます。抜き出し検索を有効にすると、より高速に検索できます。

ID_LW_MAIL（電子保存時のメール送信指定）

帳票がリスト管理サーバに登録されたことをメールで通知するかどうかを指定します。

SERVER：: リスト管理サーバの設定にしたがいます。

FALSE：: リスト管理サーバに帳票が登録されたことをメールで送信しません。

ENTRY：: リスト管理サーバに帳票が登録されたことをメールで送信します。送信時には、帳票エントリファイルを添付して送信します。

FILE：: リスト管理サーバに帳票が登録されたことをメールで送信します。送信時には、帳票ファイルを添付して送信します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定したメール送信の指定が有効になります。

注意

帳票エントリファイルを指定する（このキーに「ENTRY」を指定する）と、電子保存時に帳票の管理情報だけがメール送信されます。したがって、送信されるメールのサイズは帳票ファイルの場合よりも小さくなります。ただし、このファイルをList Worksクライアントで受信した場合、実際に帳票を表示するためには、リスト管理サーバに接続する必要があります。
帳票ファイルを指定する（このキーに「FILE」を指定する）と、電子保存時に帳票そのものがメール送信されます。このファイルをList Worksクライアントで受信した場合、帳票をそのまま表示できますが、送信されるデータ量は大きくなります。

ID_LW_MAILRCV（電子保存時のメールの宛先）

電子保存時に帳票がリスト管理サーバに登録されたことを通知するメールの宛先を64バイト以内で指定します。

宛先は、リスト管理サーバで設定されているメール環境にしたがって指定してください。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した宛先
リスト管理サーバで設定されている宛先

注意

このキーを指定する場合は、以下のいずれかでメール送信する指定にしておく必要があります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面のメール送信
ID_LW_MAILキー（「ENTRY」または「FILE」を指定）

ID_LW_PRINTBIN（電子保存後印刷の給紙方法）

電子保存後の印刷で、用紙種別が「単票」の場合に、印刷プリンタの給紙方法を指定します。

CF：: カットシートフィーダ

H1：: ホッパ1

H2：: ホッパ2

H3：: ホッパ3

H4：: ホッパ4

MA：: 手差し

NO：: 指定なし（プリンタドライバのプロパティの設定にしたがいます）

AT：: 自動

なお、給紙方法は、以下の優先順序で有効になります。

ID_LW_PRINTBINNAMEキーで指定した給紙口名
このキーで指定した給紙方法
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した給紙方法/給紙口名

注意

指定した方法で給紙されない場合は、給紙口名をID_LW_PRINTBINNAMEキーで指定してください。
このキーで給紙方法を切り替えた場合、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した給紙口名は無効になります。必要に応じて、給紙口名をID_LW_PRINTBINNAMEキーで指定してください。
給紙方法に「NO」（指定なし）または「AT」（自動）を指定した場合、給紙口名をID_LW_PRINTBINNAMEキーで指定しても無効になります。
給紙口名を指定する場合は、「NO」（指定なし）または「AT」（自動）以外を指定してください。
給紙方法を指定せずに給紙口名をID_LW_PRINTBINNAMEキーで指定した場合、給紙口名の指定は無効になります。
給紙方法に「AT」（自動）を指定しても自動給紙が正しく動作しない場合は、プリンタドライバのプロパティで自動給紙を指定し、給紙方法に「NO」（指定なし）を指定してください。
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。

ID_LW_PRINTBINNAME（電子保存後印刷の給紙口名）

電子保存後の印刷で、以下の場合に出力先のプリンタの給紙口名を32バイト以内で指定します。指定できる給紙口名は、プリンタドライバのプロパティで確認してください。

用紙種別が「単票」で給紙方法が指定した給紙口に切り替わらない場合
用紙種別が「連帳」で給紙口が正常に切り替わらない場合

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

ID_LW_PRINTBINキーで指定した給紙方法
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した給紙方法/給紙口名

注意

給紙口名は、プリンタドライバによって異なります。プリンタドライバのプロパティで確認し、文字および空白の全角・半角の違い、空白の有無などに注意して、正確に指定してください。
給紙方法をID_LW_PRINTBINキーで指定せずに給紙口名を指定した場合、給紙口名の指定は無効になります。

ID_LW_COPYNUMBER（電子保存後印刷の印刷部数）

電子保存後の印刷で、帳票の印刷部数を1 ～9999の範囲で指定します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した印刷部数が有効になります。

注意

プリンタドライバのプロパティで印刷部数が指定できないプリンタに出力する場合、以下のように動作します。
- 部単位で印刷する指定をしないとき（ID_LW_COPYNUMBERCOLLATEキーに「FALSE」を指定）、印刷部数を指定していても無効になります（1部だけ印刷されます）。
- 部単位で印刷する指定をしたとき（ID_LW_COPYNUMBERCOLLATEキーに「TRUE」を指定）、印刷部数の指定は有効になります。
ID_LW_COPYNUMBERCOLLATEキーに「DEFAULT」を指定した場合は、印刷部数を指定していても無効になります（1部だけ印刷されます）。
なお、電子保存後の部単位印刷は、ID_LW_COPYNUMBERCOLLATEキーで指定します。

ID_LW_COPYNUMBERCOLLATE（電子保存後印刷の部単位印刷の指定）

電子保存後の印刷で、印刷部数（ID_LW_COPYNUMBERキー）を指定した場合、部単位の印刷を行うかどうかを指定します。

TRUE：: 部単位で印刷します。

FALSE：: ページ単位で印刷します。

DEFAULT：: 部単位で印刷するかどうかは装置の設定にしたがいます。

印刷部数（ID_LW_COPYNUMBER）キーを指定し、このキーの呼び出しを省略すると、「DEFAULT」（部単位で印刷するかどうかは装置の設定にしたがう）が指定されたものとして動作します。

印刷部数（ID_LW_COPYNUMBER）キー、およびこのキーの両方の呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した印刷部数が有効になります。

注意

プリンタドライバのプロパティで印刷部数が指定できないプリンタに出力する場合、以下のように動作します。
- 部単位で印刷する指定をしないとき（このキーに「FALSE」を指定したとき）、印刷部数を指定していても無効になります（1部だけ印刷されます）。
- 部単位で印刷する指定をしたとき（このキーに「TRUE」を指定したとき）、印刷部数の指定は有効になります。
このキーに「DEFAULT」を指定したときは、印刷部数を指定していても無効になります（1部だけ印刷されます）。

ID_LW_PRINTSIDE（電子保存後印刷の印刷面指定）

電子保存後の印刷で、以下について指定します。

両面印刷するかどうか
マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか

SINGLEFOLLOW：: 片面印刷します。
マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

BOTHFOLLOW：: 両面印刷します。
マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

BOTH：: 両面印刷します。
マルチフォーム出力する場合は、帳票を切り替えたときに新しい用紙に印刷します。

なお、印刷面指定は、以下の優先順序で有効になります。

ID_LW_ITEMPRINTSIDEキーの指定にしたがった両面印刷と、マルチフォーム出力時に帳票を切り替えたときに新しい用紙に印刷する指定
このキーで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

注意

使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
以下の場合、このキーに「BOTH」を指定しないでください。指定した場合、正しく動作しません。
- プリンタの段組み印刷機能を使用する場合
- プリンタの白紙の出力を抑止する機能を使用する場合

ポイント

List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目にPAGE 、TPAGE 、PAGE-ALL 、TPAGE-ALL 、BPAGE、またはBTPAGE のいずれかを指定した項目が存在する帳票で、このキーに「BOTH」を指定した場合、印刷せずにページ送りされた分はカウントされません。

ID_LW_ITEMPRINTSIDE（電子保存後印刷の印刷面切り替え指定）

電子保存後の印刷で、マルチフォーム出力し（FormsクラスのChangeFormメソッドを指定した、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した）、帳票を切り替えたときに新しい用紙に印刷する指定も切り替える（各帳票で指定した帳票を切り替えたときに新しい用紙に印刷する指定を有効にする）場合に指定します。

!REPORT：: 電子保存後の印刷でマルチフォーム出力する（FormsクラスのChangeFormメソッドを指定した、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した）場合に、帳票を切り替えたときに新しい用紙に印刷する指定を有効にします。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

ID_LW_PRINTSIDEキーで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

注意

プリンタの段組み印刷機能を使用する場合、このキーを指定しないでください。指定した場合、正しく動作しません。
使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
帳票が切り替わったときに、両面印刷の指定を切り替えることはできません。
先頭の帳票で指定した両面印刷の指定が有効になります。

ID_LW_FAXSEND（電子保存時のFAX送信者情報）: このキーは未サポートです。

ID_LW_FAXRCV（電子保存時のFAX受信者情報）: このキーは未サポートです。

ID_LW_FAXRCVFILE（電子保存時のFAX受信者情報ファイル名）: このキーは未サポートです。

ID_LW_FAXSUBJECT（電子保存時のFAX送付状の用件）: このキーは未サポートです。

ID_LW_FAXCOMMENT（電子保存時のFAX送付状のコメント）: このキーは未サポートです。

ID_LW_DSTFOLDER（帳票印刷配信時の配信フォルダID）: このキーは未サポートです

ID_LW_DSTMETHOD（帳票印刷配信指定）: このキーは未サポートです。

ID_LW_STREAMENVFILE（電子帳票情報ファイル名）

帳票出力時に指定する電子帳票情報ファイル名をフルパスで指定します。

電子帳票情報ファイルとは、電子保存情報（電子保存時の動作、および属性情報など）をまとめて指定できるファイルです。電子帳票情報ファイルで指定されている情報にしたがって、帳票が電子保存されます。

電子帳票情報ファイルの詳細（記述形式、および指定できるキーワードと値など）は、List Worksに添付のオンラインマニュアルを参照してください。

このキーの呼び出しを省略すると、電子帳票情報ファイルは設定されません。

注意

電子帳票情報ファイルには、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブ、または他のキーやメソッドでサポートされている電子保存情報は指定しないでください。
このキーで指定する電子帳票情報ファイル中のデータは、必ず以下の文字コード系で記述してください。
- 帳票管理サーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- 帳票管理サーバがSolaris/Linuxの場合
  以下のいずれかの文字コード系で記述してください。
```
      － setFileTypeメソッドで指定した文字コード系
```
```
      － 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系
```
  なお、文字コード系の指定は、以下の優先順序で有効になります。
```
      1. setFileTypeメソッド
```
```
      2. 環境変数LANGおよび環境変数OA_EUCTYPE
```
なお、List Creatorコネクタ連携時の電子帳票情報ファイルの文字コード系については、オンラインマニュアル“帳票印刷配信機能運用ガイド”を参照してください。
List Creatorコネクタ連携時に、電子帳票情報ファイルを転送する場合（アプリケーションサーバに配置した場合）、電子帳票情報ファイル名は、このキーとID_LCFILE キーの両方で指定してください。その場合、このキーにはファイル名のみ指定してください。

ポイント

電子帳票情報ファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

●FAX送信情報に関するキー

注意

このキーは未サポートです。

ID_FAX_DRVNAME（FAX装置名）: このキーは未サポートです。

ID_FAX_SEND（FAX送信時のFAX送信者情報）: このキーは未サポートです。

ID_FAX_RCV（FAX送信時のFAX受信者情報）: このキーは未サポートです。

ID_FAX_RCVFILE（FAX送信時のFAX受信者情報ファイル名）: このキーは未サポートです。

ID_FAX_SUBJECT（FAX送信時のFAX送付状の用件）: このキーは未サポートです。

ID_FAX_COMMENT（FAX送信時のFAX送付状のコメント）: このキーは未サポートです。

●PDFファイル保存情報に関するキー

ポイント

PDFファイル保存情報に関するキーは、以下の場合のみ有効です。

List Works Print AgentでPDFファイル保存する場合
Web手元印刷型（PDFファイル形式）の場合

ID_KEEPPDF（PDFファイル名）

出力する帳票（PDFファイル）のファイル名を以下の範囲で指定します。

帳票配信型の場合
250バイト以内のフルパスまたはファイル名のみで指定します。
Web手元印刷型の場合
- 帳票管理サーバがWindowsの場合
  250バイト以内のフルパスまたはファイル名のみで指定します。
- 帳票管理サーバがSolaris/Linuxの場合
  512バイト以内のフルパスまたはファイル名のみで指定します。

PDFファイル名は、以下の優先順序で有効となります。

このキーで指定したPDFファイル名（フルパス）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に、このキーで指定したPDFファイル名（ファイル名のみ）で生成
帳票属性の編集コマンド（lmedtformatrコマンド）で指定した「出力ファイル名」（フルパス）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に、帳票属性の編集コマンド（lmedtformatrコマンド）で指定した「出力ファイル名」（ファイル名のみ）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に「（配信通番）.pdf」で生成

PDFファイル名は、上記のいずれかで必ず指定してください。

注意

フォルダ名のみの指定はできません。
同一名ファイルがすでに存在する場合は、アクセス権があれば新しいファイルに置き換えられます。アクセス権がない場合は、PDFファイル保存に失敗します。
同一名ファイルがすでに存在する場合にPDFファイル保存に失敗したときは、元のPDFファイルも削除されることがあります。
ID_KEEPOWFキーと同時に指定しないでください。
ID_KEEPOWFキーが指定されている場合は、ID_KEEPOWFキーで指定した値が有効になります。

ポイント

指定されたフォルダが存在しない場合、フォルダが自動作成されます。
フォルダには、親フォルダと同じアクセス権が設定されます。アクセス権がない場合は、PrintFormクラスのPrintOutメソッド呼び出し時にエラーになります。
PDFファイルのアクセス権は、以下のように設定されます。
- 帳票配信型の場合
  Administratorsグループにはフルコントロールが付与されます。Usersグループは上位フォルダの権限にしたがいます。
- Web手元印刷型、List Creatorコネクタ連携時の場合
  帳票管理サーバがWindowsの場合：
  Administratorsグループにはフルコントロールが付与されます。Usersグループは上位フォルダの権限にしたがいます。
  帳票管理サーバがSolaris/Linuxの場合：
  owner:rootおよびアクセス権は666となります。
List Creatorコネクタ連携時に、アプリケーションサーバにPDFファイルを配置する場合は、ID_RETURNPDFPATHキーで、生成するPDFファイルのパスを指定します。
PDFファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_PDF_SUBTITLE（PDFファイルのサブタイトル）

PDFファイルのサブタイトルを254バイト以内で指定します。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した概要の「サブタイトル」の指定
設定されない

注意

サブタイトルは、日本語（JIS非漢字/第一水準漢字/第二水準漢字）または英数字で指定してください。その他の文字を指定した場合、PDFファイルの文書情報（一般）で正しく表示されないことがあります。

ID_PDF_AUTHOR（PDFファイルの作成者）

PDFファイルの作成者を254バイト以内で指定します。

このキーの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した概要の「作成者」の指定
設定されない

注意

作成者は、日本語（JIS非漢字/第一水準漢字/第二水準漢字）または英数字で指定してください。その他の文字を指定した場合、PDFファイルの文書情報（一般）で正しく表示されないことがあります。

ID_PDF_PRINT（PDFファイルの印刷許可指定）

PDFファイルの印刷を許可するかどうかを指定します。

true：: 印刷を許可します。

false：: 印刷を許可しません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「印刷の許可」の指定が有効になります。

注意

このキーを指定する場合は、ID_PDF_SECUPWDキーにパスワードを必ず指定してください。
パスワードを指定しない場合、PDFファイルのセキュリティの指定が有効にならないことがあります。

ID_PDF_MODIFY（PDFファイルの変更許可指定）

PDFファイルの変更を許可するかどうかを指定します。

true：: 変更を許可します。

false：: 変更を許可しません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「文書変更の許可」の指定が有効になります。

注意

PDFファイルの変更を許可する指定をしても、PDFファイルの文書情報（セキュリティ）では「許可しない」となる場合があります。
このキーを指定する場合は、ID_PDF_SECUPWDキーにパスワードを必ず指定してください。
パスワードを指定しない場合、PDFファイルのセキュリティの指定が有効にならないことがあります。

ID_PDF_SELECT（PDFファイルのテキストとグラフィックスの選択許可指定）

PDFファイルのテキストとグラフィックスの選択を許可するかどうかを指定します。

true：: テキストとグラフィックスの選択を許可します。

false：: テキストとグラフィックスの選択を許可しません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「テキストとグラフィックスの選択の許可」の指定が有効になります。

注意

ID_PDF_ANNOTATE（PDFファイルの注釈とフォームフィールドの追加と変更許可指定）

PDFファイルの注釈とフォームフィールドの追加と変更を許可するかどうかを指定します。

true：: 注釈とフォームフィールドの追加と変更を許可します。

false：: 注釈とフォームフィールドの追加と変更を許可しません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「注釈とフォームフィールドの追加と変更の許可」の指定が有効になります。

注意

PDFファイルの注釈とフォームフィールドの追加と変更を許可する指定をしても、PDFファイルの文書情報（セキュリティ）では「許可しない」となる場合があります。
このキーを指定する場合は、ID_PDF_SECUPWDキーにパスワードを必ず指定してください。
パスワードを指定しない場合、PDFファイルのセキュリティの指定が有効にならないことがあります。

ID_PDF_PWD（PDFファイルを開くパスワード）

PDFファイルを開くときのパスワードを32バイト以内で指定します。

半角文字「"」は指定しないでください。

このキーの呼び出しを省略すると、パスワードは設定されません。

注意

パスワードは、半角の英数字または記号（ASCIIコードの文字範囲）で指定してください。その他の文字を指定した場合、PDFファイルを表示できない場合があります。
このキーとID_PDF_SECUPWDキーに同じパスワードを指定しないでください。同じパスワードを指定すると、セキュリティオプションの設定が変更される場合があります。
このキーで設定した値は直列化されません。

ID_PDF_SECUPWD（PDFファイルのセキュリティオプション変更パスワード）

PDFファイルのセキュリティオプションを変更するときのパスワードを32バイト以内で指定します。

半角文字「"」は指定しないでください。

このキーの呼び出しを省略すると、パスワードは設定されません。

注意

パスワードは、半角の英数字または記号（ASCIIコードの文字範囲）で指定してください。その他の文字を指定した場合、PDFファイルを表示できない場合があります。
このキーとID_PDF_PWDキーに同じパスワードを指定しないでください。同じパスワードを指定すると、セキュリティオプションの設定が変更される場合があります。
このキーで設定した値は直列化されません。

ID_PDF_LIMIT（PDFファイルの閲覧期限/閲覧期間）

PDFファイルの閲覧期限（閲覧開始日時または閲覧終了日時）、または閲覧期間のいずれかを指定します。

閲覧開始日時：: 閲覧開始日時を「YYYYMMDDhhmmss」の形式で指定します。
指定した日時以前は、PDFファイルの閲覧が制限されます。

閲覧終了日時：: 閲覧終了日時を「YYYYMMDDhhmmss」の形式で指定します。
指定した日時以降は、PDFファイルの閲覧が制限されます。

閲覧期間：: 閲覧期間を日単位（「1」以上の値）で指定します。
PDFファイルの作成日時から指定した期間（日数）を過ぎると閲覧が制限されます。

閲覧期限「YYYYMMDDhhmmss」を指定する場合は、以下のように指定します。

YYYY：: 年を西暦で指定します。

MM：: 01 ～ 12（月）の範囲で指定します。

DD：: 01 ～ 31（日）の範囲で指定します。

hh：: 00 ～ 23（時）の範囲で指定します。

mm：: 00 ～ 59（分）の範囲で指定します。

ss：: 00 ～ 59（秒）の範囲で指定します。

閲覧期限および閲覧期間を指定する場合、以下の順にそれぞれの値を「カンマ（,）」で区切って指定します。

閲覧開始日時
閲覧終了日時
閲覧期間

閲覧期限と閲覧期間を同時に指定した場合には、閲覧期限が有効となります。

このキーを指定したにもかかわらず、閲覧期限と閲覧期間の指定を両方とも省略した場合は、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した閲覧制限の「期間による閲覧制限を行う」の指定は無効となり、閲覧制限は行われません。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した閲覧制限の「期間による閲覧制限を行う」の指定が有効になります。

以下に、指定例を示します。

閲覧期限を指定する場合
閲覧開始日時に「2012年3月1日0時0分0秒」、閲覧終了日時に「2012年12月31日0時0分0秒」を指定する場合、以下のように指定します。
```
    setProperty( PrintProperties.ID_PDF_LIMIT, "20120301000000,20121231000000," );
```
閲覧期間を指定する場合
閲覧期間に100日を指定する場合、以下のように指定します。
```
    setProperty( PrintProperties.ID_PDF_LIMIT, ",,100" );
```

注意

List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定されている値と、このキーで指定されている値が異なる場合、このキーで指定されている値が有効となります。
このキーの指定は、PDFファイルのプレビュー時にも有効となり、以下のように動作します。
- 閲覧期限を指定した場合
  指定した閲覧可能日時の範囲外の日時でPDFファイルをプレビューしても、PDFファイルは閲覧できません。
- 閲覧期間を指定した場合
  指定した閲覧期間は、PDFファイルをプレビューした日時からの期間となります。
以下の場合はエラーとなります。
- List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した閲覧制限の「期間による閲覧制限を行う」が指定されていない場合
- 指定可能な値以外を指定した場合
Javaスクリプトが実行不能な場合など、このキーを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

ID_PDF_EMBED（PDFファイルの文字の埋め込み指定）

PDFファイルに文字を埋め込むかどうかを指定します。

ALL：: すべての文字をPDFファイルに埋め込みます。

NONE：: すべての文字をPDFファイルに埋め込みません。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した文書管理の「文字の埋め込み」の指定が有効になります。

注意

利用者定義文字やJEF拡張文字を使用する場合は、文字をPDFファイルに埋め込んでください。PDFファイルに埋め込まない場合、PDFファイルを表示するシステムの環境によっては、見え方が異なる、または正しく表示されないことがあります。

ポイント

このキーでは、埋め込んだ文字の検索を可能にします。
PDFファイルに埋め込んだ文字を検索しない場合は、ID_PDF_EMBEDREFERENCEキーで、「false」を指定してください。

ID_PDF_EMBEDREFERENCE（PDFファイルの埋め込み文字検索指定）

PDFファイルに埋め込んだ文字を検索できるようにするかどうかを指定します。

true：: 検索できるようにします。

false：: 検索できるようにしません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、「true」が指定されたものとして動作します。

注意

このキーを指定する場合は、以下のいずれかでPDFファイルに文字を埋め込む指定にしておく必要があります。
- List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した文書管理の「文字の埋め込み」の指定
- ID_PDF_EMBED キー（「ALL」を指定）
利用者定義文字やJEF拡張文字を使用する場合は、文字をPDFファイルに埋め込んでください。PDFファイルに埋め込まない場合、PDFファイルを表示するシステムの環境によっては、見え方が異なる、または正しく表示されないことがあります。
PDFファイルに埋め込んだ文字を検索できるようにする場合、PDFファイルサイズが大きくなります。

ポイント

PDFファイルにフォントを埋め込んだ場合、PDFファイルを参照するシステムにフォントがインストールされていなくても参照できます。ただし、埋め込んだ文字列を検索するには、このキーで「true」を指定する必要があります。
ID_PDF_EMBEDキーに「NONE」を指定した場合、このキーでの指定は無効になり、「false」が指定されたものとして動作します。

ID_PDF_JPEGQUALITY（PDFファイルのJPEG圧縮時の品質指定）

PDF ファイルの JPEG 圧縮時の品質を指定します。

HIGH：: 高画質、低圧縮率でJPEG圧縮します。

MID：: HIGHとLOWの中間の画質/圧縮率でJPEG圧縮します。

LOW：: 低画質、高圧縮率でJPEG圧縮します。

NONE：: JPEG圧縮されません。画質劣化のないflate圧縮が施されます。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した文書管理の「JPEG圧縮時の品質」の指定が有効になります。

ID_PDF_EMBEDFILE（PDFファイルに添付するファイル名）

PDFファイルに添付する任意のファイルのファイル名をフルパスで指定します。

ファイルは最大で99個まで指定できます。複数指定する場合は、「セミコロン（;）」で区切って指定します。同一ファイルを複数指定すると、エラーとならずに指定したとおり重複して添付されます。指定されたファイルが存在しない場合は、エラーになります。

このキーの呼び出しを省略すると、PDFファイルにファイルは添付されません。

注意

PDFファイルに添付するファイルは、Acrobat 5.0以降でのみ抽出することができます。
PDFファイルに添付するファイルは、PDFファイル保存時にセキュリティオプションを指定した場合には抽出することができません。詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“A.4 PDF変換機能使用時の注意事項”を参照してください。
このキーで指定する「PDFファイルに添付するファイル」がテキストファイルの場合、ファイル中のデータは、必ず以下の文字コード系で記述してください。
- 帳票管理サーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- 帳票管理サーバがSolaris/Linuxの場合
  以下のいずれかの文字コード系で記述してください。
```
      － setFileTypeメソッドで指定した文字コード系
```
```
      － 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系
```
  なお、文字コード系の指定は、以下の優先順序で有効になります。
```
      1. setFileTypeメソッド
```
```
      2. 環境変数LANGおよび環境変数OA_EUCTYPE
```
List Creatorコネクタ連携時に、PDFファイルに添付するファイルを転送する場合（アプリケーションサーバに配置した場合）、PDFファイルに添付するファイル名は、このキーとID_LCBINFILE キーの両方で指定してください。その場合、このキーにはファイル名のみ指定してください。

ID_PDF_AUTOPRINT（PDFファイルの自動印刷指定）

PDFファイルの自動印刷、および印刷実行のタイミングを指定します。

OFF：自動印刷しません。

OPN：PDFファイルを開くと、自動的に印刷ダイアログボックスを表示します。

OPN_CLS：PDFファイルを開くと、システムで設定されているデフォルトプリンタへ自動的に印刷されます。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイルの自動印刷を行う」の指定が有効になります。

注意

Javaスクリプトが実行不能な場合など、このキーを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

ID_PDF_HIDETOOLBAR（PDFファイル表示時のアプリケーションのツールバー表示指定）

PDFファイルを表示する場合、PDFのビューアのツールバーを表示するかどうかを指定します。

true：: PDFファイルを表示する場合、ツールバーを表示しません。

false：: PDFファイルを表示する場合、ツールバーを表示します。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイル表示時のアプリケーションの設定」の「ツールバーを表示する」の指定が有効になります。

注意

このキーを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

ID_PDF_HIDEMENUBAR（PDFファイル表示時のアプリケーションのメニューバー表示指定）

PDFファイルを表示する場合、PDFのビューアのメニューバーを表示するかどうかを指定します。

true：: PDFファイルを表示する場合、メニューバーを表示しません。

false：: PDFファイルを表示する場合、メニューバーを表示します。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイル表示時のアプリケーションの設定」の「メニューバーを表示する」の指定が有効になります。

注意

このキーを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

ID_PDF_FULLSCREEN（PDFファイル表示時のアプリケーションの全画面表示指定）

PDFファイルを表示する場合、PDFのビューアを全画面で表示するかどうかを指定します。

true：: PDFファイルを表示する場合、PDFのビューアを全画面で表示します。

false：: PDFファイルを表示する場合、PDFのビューアを全画面で表示しません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイル表示時のアプリケーションの設定」の「全画面で表示する」の指定が有効になります。

注意

このキーを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

ID_PDF_BOOKMARK（PDFファイルに帳票が切り替わったときにしおりを挿入する指定）

PDFファイルに、帳票名をしおりとして挿入するかどうかを指定します。帳票が切り替わるタイミングで、帳票名がしおりとして挿入されます。

true：: 帳票が切り替わったときにしおりを挿入します。

false：: 帳票が切り替わったときにしおりを挿入しません。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、「false」が指定されたものとして動作します。

注意

マルチフォーム出力の場合、帳票が切り替わるタイミングでしおりが挿入されます。
組合せフォーム出力の場合、しおりとして挿入される名前は、組合せフォーム名となります。組合せフォーム名が切り替わったタイミングで、しおりが挿入されます。
このオプションで設定されるしおりは1階層です。

ポイント

挿入したしおりを表示した状態でPDFファイルを作成する場合は、PDF文書情報ファイルのPDF-PAGEMODEキーワードに、「OUTLINES」を指定してください。

ID_PDF_BOOKMARKITEM（PDFファイルにデータが切り替わったときにしおりを挿入する指定）

PDF ファイルに、帳票の項目データの値をしおりとして挿入する場合に、対象となる項目名を指定します。指定した項目の入力データの値が切り替わるタイミングで、その項目の値がしおりとして挿入されます。

項目名には、「テキスト項目」、および「非出力項目」で項目形式がテキスト項目である項目が1つ指定できます。

また、指定した項目に対し、それぞれ以下の出力のタイミングでしおりが挿入されます。

テキスト項目の場合
ページ内の最初の項目を出力するタイミングでしおりが挿入されます。
非出力項目
ページ内の最初のレコードを出力するタイミングでしおりが挿入されます。

また、上記の出力のタイミングで、しおりを挿入するタイミングを任意で複数指定することができます。複数指定する場合は、項目名の先頭に「！」を付けて「カンマ（,）」で区切って指定します。「！」を付けて指定した項目の入力データが切り替わるタイミングで、しおりを挿入する項目のその時点の「データ値」がしおりとして挿入されます。

このキーの呼び出しを省略すると、帳票の項目データが切り替わるタイミングでしおりは挿入されません。

このキーと同時にID_PDF_BOOKMARKキーを指定した場合、ID_PDF_BOOKMARKキーによって帳票名で挿入されたしおりの階層がもっとも高く、その階層下に、このキーの指定にしたがって、以下の形式でしおりが挿入されます。

[帳票名]-[データ値]

データ値は、このキーによって挿入される最初のデータ値になります。この場合、このしおりが最上位のしおりになり、その下の階層にこのキーで指定した項目の値がしおりとして挿入されます。

ID_PDF_BOOKMARKITEMキーには「!部門,!所属,名前」のような形式で指定します。この場合、[部門]、[所属]、および[名前]の入力データが切り替わったタイミングで、 [名前]のデータ値がしおりとして挿入されます。

setProperty( PrintProperties.ID_PDF_BOOKMARKITEM, "!部門,!所属,名前" );

注意

指定した項目に対する入力データ値がない場合、しおりは挿入されません。
集団項目およびList Creatorデザイナのデータ定義画面の［環境定義］タブで、集団項目の扱いに「集団項目名を使用」を選択した場合の集団項目の構成項目は指定できません。
しおりを挿入する項目のデータは、必ずページの先頭でデータを切り替えてください。ページの先頭でデータを切り替えなかった場合、帳票出力時にエラーになります。
集計表形式、およびフリーフレーム形式の帳票の場合、テキスト項目はページの最初に出力するパーティションに定義した項目を指定してください。
しおりが128文字を超えた場合、129文字目以降は切り捨てられます。
このキーで設定されるしおりは1 階層です。マルチフォーム出力/ 組合せフォーム出力時にID_PDF_BOOKMARKキーと合わせて指定した場合、設定されるしおりは2 階層となります。

ポイント

挿入したしおりを表示した状態でPDFファイルを作成する場合は、PDF文書情報ファイルのPDF-PAGEMODEキーワードに、「OUTLINES」を指定してください。

ID_PDF_BOOKMARKITEM2（PDFファイルにデータが切り替わったときにしおり（多階層）を挿入する指定）

PDFファイルに、帳票の項目データの値をしおりとして挿入する場合に、対象となる項目名を指定します。指定した項目の入力データの値が切り替わるタイミングで、その項目の値がしおり文字列として挿入されます。

項目名には「テキスト項目」、および「非出力項目」で項目形式がテキスト項目である項目が指定できます。項目は「カンマ(,) 」で区切って最大10 個まで指定できます。項目を複数指定した場合は、指定した順番で階層化されたしおりが挿入されます。

このキーを省略すると、帳票の項目データが切り替わるタイミングでしおりは挿入されません。

このキーと同時にID_PDF_BOOKMARKITEMキーは指定できません。指定した場合、帳票出力時にエラーとなります。

このキーと同時にID_PDF_BOOKMARKキーを指定した場合、ID_PDF_BOOKMARKキーによって帳票名で挿入されたしおりの階層がもっとも高く、その階層下に、このキーの指定にしたがってしおりが挿入されます。

注意

ID_PDF_BOOKMARKITEMキーと同時に指定しないでください。
指定した項目に対する入力データ値がない場合、しおりは挿入されません。
集団項目およびデータ定義画面の［環境定義］タブで、集団項目の扱いに「集団項目名を使用」を選択した場合の集団項目の構成項目は指定できません。
集計表形式、およびフリーフレーム形式の帳票の場合、しおりは、このキーに指定したテキスト項目が挿入されたパーティションが出力されるタイミングで挿入されます。このため、このキーで下位の階層に指定したテキスト項目が挿入されたパーティションが、上位の階層に指定したテキスト項目が挿入されたパーティションよりも先に出力されると、正しくしおりが挿入されません。しおりを挿入する際は、このキーで指定した階層の順に、テキスト項目が挿入されたパーティションが出力されるよう考慮してください。
しおり文字列が128文字を超えた場合、129文字目以降は切り捨てられます。
挿入したしおりを表示した状態でPDF ファイルを作成する場合は、PDF 文書情報ファイルのPDF-PAGEMODEキーワードで、PDFを開いた場合の表示方法を「OUTLINES」と設定してください。
帳票管理サーバがSolarisの場合、本機能は使用できません。

以下に指定例を示します。

この例では、[部門]、[所属]、および[名前]の入力データが切り替わったタイミングで、しおりが3 階層で挿入されます。このとき、[部門]の階層がもっとも高く、その階層下に[所属]、[名前]と3階層となります。

ID_PDF_BOOKMARKITEM2 部門,所属,名前

ID_PDF_DOCENVFILE（PDF文書情報ファイル名）

帳票出力時に使用するPDF文書情報ファイル名をフルパスで指定します。

PDF 文書情報ファイルは、帳票をPDF ファイルで保存する場合のプロパティ（PDF ファイル出力時の属性情報）を一括指定できるファイルです。

PDF文書情報ファイルの詳細（ファイルの記述方法、指定できるキーワードと値など）については、オンラインマニュアル“帳票印刷配信機能 PDF運用ガイド”を参照してください。

注意

PDF文書情報ファイルには、PDFファイル保存情報（メール配信）に関する情報は指定しないでください。PDFメール配信時の情報は、ID_EXECBUFFERキー、またはPDFメール配信情報ファイルで指定してください。
PDF文書情報ファイルは、帳票のプロパティおよび他のキーやメソッドでサポートされていないPDFファイル保存情報を指定する場合に使用します。
List Creatorコネクタ連携時に、PDF文書情報ファイルを転送する場合（アプリケーションサーバに配置した場合）、PDF文書情報ファイル名は、このキーとID_LCFILE キーの両方で指定してください。その場合、このキーにはファイル名のみ指定してください。
このキーで指定するPDF文書情報ファイル中のデータは、必ず以下の文字コード系で記述してください。
- 帳票管理サーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- 帳票管理サーバがSolaris/Linuxの場合
  以下のいずれかの文字コード系で記述してください。
```
      － setFileTypeメソッドで指定した文字コード系
```
```
      － 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系
```
  なお、文字コード系の指定は、以下の優先順序で有効になります。
```
      1. setFileTypeメソッド
```
```
      2. 環境変数LANGおよび環境変数OA_EUCTYPE
```
なお、List Creatorコネクタ連携時のPDF文書情報ファイルの文字コード系については、オンラインマニュアル“帳票印刷配信機能運用ガイド”を参照してください。
PDF文書情報ファイルでPDF-LIMITURIキーワードを指定する場合は、
List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で閲覧制限で「URIによる閲覧制限を行う」を指定する必要があります。指定されていない場合は、エラーとなります。
PDF文書情報ファイルでPDF-LIMITURIキーワードを指定した場合、
List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で閲覧制限で設定した「閲覧可能なサイト」は無効となります。

ポイント

メールを暗号化して送信、またはテンプレートを使用したメール送信機能を利用する場合は、PDFメール配信情報ファイルを利用してください。
PDF文書情報ファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

ID_PDF_OUTINFOFILE（ECM情報ファイル名）: このキーは未サポートです。

●印刷属性情報に関するキー

ポイント

印刷属性情報に関するキーは、以下の場合のみ有効です。

List Works Print Agentで印刷する場合
List Works Workstationで、出力装置にPrint Managerで定義したプリンタを指定した場合

ID_PRTMODE（出力開始時の動作モード）

帳票の出力開始時の動作モードを指定します。

OUTPUT：: すぐに帳票を出力します。

HOLDCL：: すぐに帳票を出力しないで、いったんクライアント側のスプールに保留します。クライアント側とは、List Managerの帳票出力サーバが動作するコンピュータを指します。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面で指定した出力開始時の動作モードが有効になります。

注意

List Managerの帳票出力サーバで帳票の出力を保留するときは、以下のいずれかで出力開始時の動作モードをクライアント側で保留する設定にしておく必要があります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の出力開始時の動作モード
ID_PRTMODEキー（「HOLDCL」を指定する）

ポイント

このキーで「HOLDCL」を指定した場合、以下の方法で保留解除できます。

List Managerの帳票一覧画面から出力する
List Managerの帳票ブラウザの出力指示画面から出力する
帳票の出力/出力中止コマンド（lmoprprintコマンド）を使用して出力する
帳票管理Javaインタフェースを使用して出力する

ID_JOBHRESUME（保留解除日時）: このキーは未サポートです。

ID_JOBPRIORITY（出力時の優先順位）

帳票の出力処理の優先順位を1～99の範囲で指定します。

数字が大きいほど優先順位は高くなります。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面で指定した出力時の優先順位が有効になります。

ID_INFORM（メッセージ通知先（通知メッセージ））

帳票の出力中に出力装置にエラーが発生した場合の通知メッセージや、出力経過の通知メッセージの通知先コンピュータ名（ホスト名）またはIPアドレスを255バイト以内で指定します。

このキーを指定すると、以下の条件にあてはまる場合に、指定したメッセージ通知先に通知メッセージが通知されます。

帳票の出力中に出力装置にエラーが発生した場合
出力経過の通知メッセージを通知したい場合

このキーの呼び出しを省略すると、通知メッセージは通知されません。

注意

コンピュータ名（ホスト名）とTCP/IPのホスト名は同一となるようネットワークの設定を行ってください。コンピュータ名（ホスト名）とTCP/IPのホスト名が異なる場合は、IPアドレスで指定してください。
通知メッセージは、「メッセージ通知先（通知メッセージ）」に指定したコンピュータの到着通知パネルに通知されます。したがって、通知メッセージの確認および対処を行う場合、通知先コンピュータであらかじめ「到着通知パネル」を起動しておく必要があります。

ポイント

以下のいずれかで、帳票の出力状態が「登録」、「失敗」「中止」、「出力済」または「出力保留」の帳票を出力する場合、このキーで指定したメッセージ通知先（通知メッセージ）を変更することができます。
- 帳票の出力/出力中止コマンド（lmoprprintコマンド）
- 帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）
- 帳票管理Javaインタフェース
メッセージ通知先（通知メッセージ）に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”
通知されるメッセージの詳細については、以下を参照してください。
⇒“B.2 メッセージ通知について”

ID_JOBRMSGHOST（メッセージ通知先（返答メッセージ/応答メッセージ））

帳票の出力中に対処（操作やリカバリなど）が必要なエラーが発生した場合の返答メッセージ/応答メッセージの通知先コンピュータ名（ホスト名）またはIPアドレスを255 バイト以内で指定します。

このキーを指定すると、以下の条件にあてはまる場合に、指定したメッセージ通知先に返答メッセージ/応答メッセージが通知されます。

帳票の出力中に出力装置にエラーが発生した場合
操作や応答が必要なメッセージを通知する場合

このキーの呼び出しを省略した場合、またはこのキーで指定したメッセージ通知先にメッセージを通知できなかった場合は、帳票出力サーバの環境設定コマンド（setenvdefコマンド、またはsetenvprtコマンド）で指定したメッセージ通知先に通知されます。どのメッセージ通知先にもメッセージが通知できない場合、帳票出力サーバに通知されます。

注意

コンピュータ名（ホスト名）とTCP/IPのホスト名は同一となるようネットワークの設定を行ってください。コンピュータ名（ホスト名）とTCP/IPのホスト名が異なる場合は、IPアドレスで指定してください。
返答メッセージ/応答メッセージは、「メッセージ通知先（返答メッセージ/応答メッセージ）」に指定したコンピュータの到着通知パネルに通知されます。したがって、返答メッセージ/応答メッセージの確認および対処を行う場合、通知先コンピュータであらかじめ「到着通知パネル」を起動しておく必要があります。
帳票出力サーバの環境設定コマンド（setenvdefコマンド、またはsetenvprtコマンド）のメッセージ通知先に、不当なコンピュータ名が指定されている場合、このキーで指定したメッセージ通知先に返答メッセージが通知されていても、不当な指定に対してイベントログにエラーが出力されます。

ポイント

以下のいずれかで、帳票の出力状態が「登録」、「失敗」「中止」、「出力済」または「出力保留」の帳票を出力する場合、このキーで指定したメッセージ通知先（返答メッセージ/応答メッセージ）を変更することができます。
- 帳票の出力/出力中止コマンド（lmoprprintコマンド）
- 帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）
- 帳票管理Javaインタフェース
List Works Print AgentまたはList Works Workstationで、返答メッセージ/応答メッセージを到着通知パネルに表示する場合は、帳票出力サーバの環境設定ファイルでMsgNoticeキーに「1」を設定する必要があります。
帳票出力サーバの環境設定コマンド（setenvdefコマンド、またはsetenvprtコマンド）でメッセージ通知先を複数指定した場合は、指定した順に通信可能なコンピュータにメッセージが通知されます。
メッセージ通知先（返答メッセージ/応答メッセージ）に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”
通知されるメッセージの詳細については、以下を参照してください。
⇒“B.2 メッセージ通知について”

ID_JOBBANNER（区切りページ出力指定）

区切りページを出力するかどうかを指定します。

このキーは、区切りページを出力しない場合にのみ指定してください。

false：: 区切りページを出力しません。

このキーの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの区切りページ出力設定画面の指定が有効になります。

また、このキーに「false」以外の値を指定した場合、「false」が指定されたものとして動作します。

注意

プリンタドライバの設定で RAW データでスプールする設定になっている場合、区切りページは出力されません。

ID_JOBWAIT（出力完了待ち合わせ）: このキーは未サポートです。

ID_JOBPAPERCODE（用紙交換メッセージ指定）

用紙交換メッセージを通知する場合に、以下の情報を「セミコロン（;）」で区切って指定します。

用紙交換メッセージに通知する用紙コード（必須）
用紙交換メッセージを通知する場合の条件指定

以下に、それぞれの指定内容について説明します。

用紙交換メッセージに通知する用紙コード（必須）
用紙交換メッセージに通知する用紙コード（用紙名）を40 バイト以内で指定します。
このキーを指定した場合は必ず指定してください。指定しない場合はエラーとなります。
用紙コードには「セミコロン（;）」は指定できません。また、40 バイトを超えた部分は切り捨てられます。
用紙交換メッセージを通知する場合の条件指定
用紙交換メッセージを通知する条件を指定します。
Y：
常に用紙交換メッセージを通知します。
このキーで指定した用紙コードが前回の印刷時と同じでも、用紙交換メッセージを通知します。
N：
用紙の変更時にのみ用紙交換メッセージを通知します。
このキーで指定した用紙コードが前回の印刷時から変更されている場合、用紙交換メッセージを通知します。

このキーを指定する場合に、「用紙交換メッセージを通知する場合の条件指定」を省略した場合は、「N」が指定されたものとして動作します。

このキーの呼び出しを省略すると、帳票属性の編集コマンド（lmedtformatrコマンド）で指定した用紙コードおよび用紙交換メッセージの表示指定がそれぞれ有効になります。

注意

出力開始メッセージも通知する場合、出力開始メッセージと用紙交換メッセージが二重で通知される場合があります。
VSP/VS/PS5000シリーズのプリンタに印刷する場合、用紙交換メッセージを通知する指定を行うと、用紙交換メッセージが二重に通知される場合があります。

ポイント

用紙コード（用紙名）に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

以下に指定例を示します。

この例では、用紙交換メッセージに通知する用紙名に「B5」、および「常に用紙交換メッセージ通知する」と指定しています。

setProperty( PrintProperties.ID_JOBPAPERCODE, "B5;Y" );

ID_JOBUSERNAME（印刷ドキュメントの所有者名（ユーザ名））: このキーは未サポートです。

●OWFファイル生成情報に関するキー

ポイント

List Managerでは、帳票管理サーバでOWFファイルを生成し、Web手元印刷を行うことができます。

ID_KEEPOWF（OWFファイル名）

出力する帳票（OWFファイル）のファイル名を、以下の範囲で指定します。

帳票管理サーバがWindowsの場合
250バイト以内のフルパスまたはファイル名のみで指定します。
帳票管理サーバがSolaris/Linuxの場合
512バイト以内のフルパスまたはファイル名のみで指定します。

OWFファイル名は、以下の優先順序で有効になります。

このキーで指定したOWFファイル名（フルパス）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に、このキーで指定したOWFファイル名（ファイル名のみ）で生成
帳票属性の編集コマンド（lmedtformatrコマンド）で指定した「出力ファイル名」（フルパス）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に、帳票属性の編集コマンド（lmedtformatrコマンド）で指定した「出力ファイル名」（ファイル名のみ）で生成

OWFファイル名は、いずれかで必ず指定してください。

注意

フォルダ名のみの指定はできません。
OWFファイル名の拡張子は必ず「.owf」（半角小文字）を指定してください。「.owf」以外の拡張子を指定した場合、Webプラグインが起動されません。
フォルダ名のみの指定はできません。
このキーで指定したファイル名と同一のファイル名がすでに存在する場合はエラーになります。ただし、存在するファイルのサイズが0バイトの場合、エラーとならずに上書きされます。
同一名ファイルがすでに0バイトで存在するときにOWFファイル生成に失敗した場合は、元のOWFファイルも削除されることがあります。
ID_KEEPPDFキーと同時に指定しないでください。
このキーを省略し、かつID_KEEPPDFキーが設定されている場合は、ID_KEEPPDFキーで設定した値が有効です。

ポイント

OWFファイルのアクセス権は、以下のように設定されます。
- 帳票管理サーバがWindowsの場合
  Administratorsグループにはフルコントロールが付与されます。Usersグループは上位フォルダの権限にしたがいます。
- 帳票管理サーバがSolaris/Linuxの場合
  owner:rootおよびアクセス権は666となります。
OWFファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”
List Creatorコネクタ連携時に、アプリケーションサーバにOWFファイルを配置する場合は、ID_RETURNOWFPATHキーでアプリケーションサーバのOWFファイルのパスを指定します。

ID_OWF_DESTINATION（Webプラグイン起動時の動作モード）

Webプラグイン起動時の動作モードを指定します。

PREVIEW：: プレビューします。

PRINT：: 印刷します。

このキーの呼び出しを省略すると、「PREVIEW」が指定されたものとして動作します。

ID_OWF_OPENPRTDLG（印刷時の印刷画面の表示指定）

印刷時（ID_OWF_DESTINATIONキーに「PRINT」を指定した場合）に印刷画面を表示するかどうかを指定します。印刷画面を表示する場合は、印刷出力時の情報を指定することができます。

false：: 印刷時に印刷画面を表示しません。

true：: 印刷時に印刷画面を表示します。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、「false」が指定されたものとして動作します。

ID_OWF_PRTCLOSE（印刷終了後にWebブラウザを閉じる指定）

印刷完了後、Webブラウザを閉じるかどうかを指定します。

false：: 印刷完了後に、Webブラウザを閉じません。

true：: 印刷完了後に、Webブラウザを閉じます。

このキーに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このキーの呼び出しを省略すると、「false」が指定されたものとして動作します。

注意

このキーは、ID_OWF_DESTINATIONキーに「PRINT」を指定して印刷した場合のみ有効になります。
HTMLのフレーム機能使用時には設定しないでください。

ID_OWF_PREVIEWRATE（プレビュー時のズーム率指定）

プレビュー時のズーム率を指定します。

0：: ページ全体を表示します。

W：: ページの横幅に合わせて表示します。

30～200：: 指定した倍率（％）で表示します。30～200の範囲の文字列を指定します。

このキーの呼び出しを省略すると、「0」が指定されたものとして動作します。

ID_OWF_PRTPREVENTION（プレビュー時の印刷制御指定）

プレビュー時の印刷制御方法を指定します。

FALSE：: 印刷を抑止しません。

TWICE：: 2重印刷を抑止します。

TRUE：: 印刷を抑止します。

このキーの呼び出しを省略すると、「FALSE」が指定されたものとして動作します。

ID_OWF_EMBED（OWFファイルへの外字エンベッド指定）

OWFファイルに外字をエンベッド（貼り付け）するかどうかを指定します。

FALSE：: 外字をエンベッドしません。

USER：: 外字をエンベッドします。

このキーの呼び出しを省略すると、「FALSE」が指定されたものとして動作します。

注意

エンベッドする外字は、以下の方法で登録する必要があります（登録されていない外字はエンベッドされません）。

ID_OWF_REGFONTキーによるフォントの登録
環境設定によるフォントの登録

フォントの登録については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。

以下の場合、外字エンベッド機能は未サポートです。
- 組合せフォーム出力する場合

ID_OWF_REGFONT（外字フォントファイル登録）

任意のフォルダに格納されている外字フォントファイルを登録します。

TTFファイルを指定する場合は、「ttfpath,ttepath」の形式で、「カンマ（,）」で区切って指定します。TTCファイルを指定する場合は、「ttcpath,ttepath,order」の形式で、「カンマ（,）」で区切って指定します。

複数ファイルの登録を行う場合は、「セミコロン（;）」で区切って指定します。ただし、同じフォントファイルに対して複数回指定した場合は、最後に指定した外字フォントファイルが有効になります。

ttfpath/ttcpath：: フォントファイル（TTFファイルまたはTTCファイル）へのフルパスを指定します。

ttepath：: リンクする外字フォントファイル（TTEファイル）へのフルパスを指定します。

order：: TTCファイルを指定するときは、TTCファイル内の何番目の書体を登録するかを指定します。
先頭の書体を登録する場合は、「1」を指定します。

このキーによる外字フォントファイルの登録は、以下のような場合に使用します。

環境設定で登録されていないフォントの外字をエンベッドしたい場合
環境設定で登録されているフォントの外字を一時的に異なる外字に変更し、変更した外字をエンベッドしたい場合

このキーの呼び出しを省略する、またはこのキーで指定されなかったフォントについては、環境設定で登録したフォントが有効になります。

フォントの登録については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。

注意

環境設定で登録されているフォントに対して、このキーで外字フォントファイルを登録した場合、このキーで指定した外字フォントファイルが有効になります。
ID_OWF_REGFONTキーを指定する場合、ttfpathパラメータにTTCファイルを指定することはできません。指定した場合、例外（OwfFileException[reason:ERR_INVALID_PARAMETER]）が発生します。
また、ttcpathパラメータにTTFファイルを指定することはできません。
外字フォントファイル名が同一で格納先が異なる指定は行わないでください。
ファイルパスに「カンマ（,）」、「セミコロン（;）」は指定できません。
以下の場合、外字エンベッド機能は未サポートです。
- 組合せフォーム出力する場合

ID_OWF_WORKDIRECTRY（OWFファイル生成時の作業ディレクトリ）: このキーは未サポートです。

●List Creatorコネクタ連携情報に関するキー

ID_HOST（通信対象コンピュータ名）

通信対象の帳票管理サーバのコンピュータ名（ホスト名）を、TCP/IPのホスト名またはIPアドレスで指定します。

List Creatorコネクタ連携時、このキーは必ず指定してください。

注意

帳票管理サーバがWindowsの場合、コンピュータ名（ホスト名）とTCP/IPのホスト名は同一となるようネットワークの設定を行ってください。コンピュータ名（ホスト名）とTCP/IPのホスト名が異なる場合は、IPアドレスで指定してください。

ID_COMPRESSRESOURCE（転送データの圧縮指定）

帳票出力時に、アプリケーションサーバから転送されるデータを圧縮する場合に指定します。

このキーで「COMPRESS」を指定すると、帳票資源（帳票定義情報、入力データ、メディアデータファイルなど）が帳票管理サーバへ転送される場合に、転送対象のデータが圧縮されて転送されます。

UNCOMPRESS：: 圧縮しないで転送します。

COMPRESS：: 圧縮して転送します。

このキーの呼び出しを省略すると、「UNCOMPRESS」が指定されたものとして動作します。

ID_SENDRESOURCE（帳票定義情報の転送指定）

帳票出力時に、アプリケーションサーバに配置した帳票定義情報を使用するかどうか（帳票定義情報を帳票管理サーバに転送するかどうか）を指定します。

SEND：: 帳票定義情報を転送します。アプリケーションサーバに配置した帳票定義情報を使用して帳票出力します。

NOSEND：: 帳票定義情報は転送しません。帳票管理サーバに配置済みの帳票定義情報を使用して帳票出力します。

このキーの呼び出しを省略すると、「SEND」が指定されたものとして動作します。

注意

このキーで「NOSEND」を指定した場合、ID_REMOTEDIRECTORYキーで帳票管理サーバの帳票格納ディレクトリを指定してください。

ID_UPDATERESOURCE（転送先ディレクトリに同一ファイル名が存在した場合の制御指定）: このキーは未サポートです。

ID_LCVISUALFILE（転送メディアデータファイル名）

アプリケーションサーバのメディアデータファイルを帳票管理サーバに転送する場合に、アプリケーションサーバのメディアデータファイル名をフルパスで指定します。複数のファイルを指定する場合は、「セミコロン（;）」で区切って指定します。

このキーの呼び出しを省略すると、メディアデータファイルは転送されません。

なお、メディアデータファイルは、以下の優先順序で有効になります。

帳票配信型の場合

このキーにより転送したメディアデータファイル
ID_CMVISUALFILEキーで指定した帳票管理サーバにあらかじめ配置してあるメディアデータファイル
ID_VISUALDIRキーで指定した帳票出力サーバのメディアデータ格納ディレクトリ配下のメディアデータファイル
帳票出力サーバの環境設定ファイルのLmlcMediaDirキーで指定したメディアデータ格納ディレクトリ配下のメディアデータファイル

Web手元印刷型（PDFファイル形式）の場合

このキーにより転送したメディアデータファイル
ID_CMVISUALFILEキーで指定した帳票管理サーバにあらかじめ配置してあるメディアデータファイル
ID_VISUALDIRキーで指定した帳票管理サーバのメディアデータ格納ディレクトリ配下のメディアデータファイル
帳票管理サーバの環境設定ファイルのLmlcMediaDirキーで指定したメディアデータ格納ディレクトリ配下のメディアデータファイル

Web手元印刷型（OWFファイル形式）の場合

このキーにより転送したメディアデータファイル
ID_CMVISUALFILEキーで指定した帳票管理サーバにあらかじめ配置してあるメディアデータファイル

注意

このキーで指定したメディアデータファイルは、アプリケーションサーバ上に配置してください。
メディアデータファイルを転送する場合、組込みメディア項目に対する入力データ中のメディアデータファイル名はファイル名のみを指定してください。

ポイント

アプリケーションサーバから帳票管理サーバにファイルを転送するときに指定可能なファイルパス長については、以下を参照してください。
⇒“4.10.3 List Creatorコネクタ連携時の注意事項”
転送された資源の扱いについては、オンラインマニュアル“帳票印刷配信機能運用ガイド”を参照してください。

ID_REMOTEDIRECTORY（帳票出力時の帳票格納ディレクトリ）

帳票管理サーバの帳票格納ディレクトリをフルパスで指定します。

帳票出力時にアプリケーションサーバから帳票定義情報を転送しない場合（ID_SENDRESOURCEキーで「NOSEND」を指定した場合）は、このキーで帳票定義情報が配置されている帳票管理サーバの帳票格納ディレクトリを指定します。

このキーの呼び出しを省略すると、以下の帳票管理サーバの環境設定ファイルの「LmlcFormDir」キーの省略値が有効になります。

帳票管理サーバがWindowsの場合

（List Worksインストールフォルダ）\Listmanager¥Manager¥formdir

帳票管理サーバがSolaris/Linuxの場合
```
/var/opt/FJSVlstm/formdir
```

注意

帳票格納ディレクトリのパスの区切りには、以下を指定してください。
- 帳票管理サーバがWindowsの場合
  「円マーク（¥）」
- 帳票管理サーバがSolaris/Linuxの場合
  「スラッシュ（/）」
帳票格納ディレクトリのパスの末尾には、以下を指定しないでください。
- 帳票管理サーバがWindowsの場合
  「円マーク（¥）」
- 帳票管理サーバがSolaris/Linuxの場合
  「スラッシュ（/）」
帳票管理サーバがWindowsの場合、帳票格納ディレクトリとして、ネットワークドライブ（UNC 指定（¥¥コンピュータ名¥共有名¥ディレクトリ名）を除く）、およびリムーバブルディスクを指定しないでください。

ID_LCLWFAXRCVFILE（転送電子保存時のFAX受信者情報ファイル名）: このキーは未サポートです。

ID_LCFAXRCVFILE（転送FAX送信時のFAX受信者情報ファイル名）: このキーは未サポートです。

ID_LCFILE（転送ファイル名）

アプリケーションサーバからファイルを転送する場合に、転送するファイル名をフルパスで指定します。

複数のファイルを指定する場合は、「セミコロン（;）」で区切って指定します。

このキーで指定したファイルは、アプリケーションサーバから帳票管理サーバへ転送される場合に、自動的にファイルの文字コード変換が行われます。

情報ファイルおよびList Manager管理情報ファイルを転送する場合は、必ずこのキーで指定してください。

以下に、情報ファイル、およびList Manager管理情報ファイルを転送する場合のファイルの指定方法について説明します。

置換フォント情報ファイルを転送する場合
このキーとID_MAPFONTFILEキーの両方で指定します。ID_MAPFONTFILEキーにはファイル名のみ指定してください。
バーコード補正情報ファイルを転送する場合
このキーとID_BCODADJUSTキーの両方で指定します。ID_BCODADJUSTキーにはファイル名のみ指定してください。
電子帳票情報ファイルを転送する場合
電子帳票情報ファイルは、Interstage List Manager互換のための機能で使用するファイルです。
このキーとID_LW_STREAMENVFILEキーの両方で指定します。ID_LW_STREAMENVFILEキーにはファイル名のみ指定してください。
PDF文書情報ファイルを転送する場合
このキーとID_PDF_DOCENVFILEキーの両方で指定します。ID_PDF_DOCENVFILEキーにはファイル名のみ指定してください。
PDFメール配信情報ファイルを転送する場合
このキーとID_EXECBUFFERキーで指定するprprintコマンドの-gpdfmailconffileオプションの両方で指定します。-gpdfmailconffileオプションにはファイル名のみ指定してください。
List Manager管理情報ファイルを転送する場合
このキーとID_LM_INFOFILEキーの両方で指定します。ID_LM_INFOFILEキーにはファイル名のみ指定してください。
帳票出力情報ファイルを使用する場合
このキーとID_PRINTENVFILEキーで指定します。ID_PRINTENVFILE キーにはファイル名のみ指定してください。
組合せフォーム定義ファイルを転送する場合
このキーと、Formsクラス/FormsFileクラス/FormsStreamクラスのsetCbFileメソッドの両方で指定します。
setCbFileメソッドにはファイル名のみ指定してください。

注意

このキーで指定したファイルは、アプリケーションサーバ上に配置してください。
このキーで指定する情報ファイルおよびList Manager管理情報ファイル中のデータは、必ず以下の文字コード系で記述してください。
- アプリケーションサーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- アプリケーションサーバがSolaris/Linuxの場合
  以下のいずれかの文字コード系で記述してください。
```
      － setFileTypeメソッドで指定した文字コード系
```
```
      － 環境変数LANGおよび環境変数OA_EUCTYPEで指定した文字コード系
```
  ただし、帳票管理サーバがWindowsの場合は、Shift-JISの文字コード系の範囲で指定してください。Shift-JIS以外の文字コード系で記述すると、帳票管理サーバ側でShift-JISに変換されます。そのため、縮退が発生し、代替文字「_」または「＿」で出力されます。
  なお、文字コード系の指定は、以下の優先順序で有効になります。
```
      1. setFileTypeメソッド
```
```
      2. 環境変数LANGおよび環境変数OA_EUCTYPE
```

ポイント

PDFファイルに添付する任意のファイルを転送する場合は、ID_LCBINFILEキーで指定してください。
List Creatorコネクタ連携時、アプリケーションサーバから帳票管理サーバにファイルを転送するときに指定可能なファイルパス長については、以下を参照してください。
⇒“4.10.3 List Creatorコネクタ連携時の注意事項”
転送された資源の扱いについては、オンラインマニュアル“帳票印刷配信機能運用ガイド”を参照してください。

ID_LCBINFILE（バイナリ転送時の転送ファイル名）

アプリケーションサーバからファイルをバイナリモードで転送する場合に、転送するファイル名をフルパスで指定します。

複数のファイルを指定する場合は、「セミコロン（;）」で区切って指定します。

PDFファイルに添付する任意のファイルを転送する場合は、必ずこのキーで指定してください。

バイナリモードで転送するファイル名は、このキーとID_PDF_EMBEDFILEキーの両方で指定します。

注意

このキーで指定したファイルは、アプリケーションサーバ上に配置してください。

ポイント

情報ファイル、またはList Manager管理情報ファイルを転送する場合は、ID_LCFILEキーで指定してください。
List Creatorコネクタ連携時、アプリケーションサーバから帳票管理サーバにファイルを転送するときに指定可能なファイルパス長については、以下を参照してください。
⇒“4.10.3 List Creatorコネクタ連携時の注意事項”
転送された資源の扱いについては、オンラインマニュアル“帳票印刷配信機能運用ガイド”を参照してください。

ID_RETURNPDFPATH（配置するPDFファイル名）

出力する（アプリケーションサーバに配置する）PDFファイル名をフルパスで指定します。

このキーを指定すると、帳票管理サーバで帳票（PDFファイル）が出力され、アプリケーションサーバへ転送して配置されます。

なお、フルパスに全角文字、半角カナ文字は指定しないでください。

注意

ID_RETURNOWFPATHキーと同時に指定しないでください。
このキーで指定したファイル名と同一のファイル名がすでに存在する場合はエラーとなります。
このキーを指定する場合、論理デバイスの出力方法にWeb手元印刷のPDF（PDFファイル）を指定してください。また、指定する論理あて先に論理あて先グループは指定しないでください。
帳票管理サーバで生成したPDFファイルをアプリケーションサーバに転送する場合、以下のいずれかで「帳票作成後の出力指定」を「出力する」と指定する必要があります。
- ID_LM_OUTMODEキーに「DO」を指定する
- あらかじめ帳票属性の編集コマンド（lmedtformatrコマンド）の-outputmodeオプションに「1」を指定しておく
- あらかじめ論理あて先の編集コマンド（lmedtldコマンド）の-outputmodeオプションに「1」を指定しておく

ポイント

生成されるPDFファイルのアクセス権は、以下のように設定されます。
- アプリケーションサーバがWindowsの場合
```
      PDFファイルが格納されるフォルダのアクセス権が引き継がれます。
```
- アプリケーションサーバがSolaris/Linuxの場合
```
      owner:rootおよびアクセス権は666となります。
```
List Creatorコネクタ連携時、アプリケーションサーバから帳票管理サーバにファイルを転送するときに指定可能なファイルパス長については、以下を参照してください。
⇒“4.10.3 List Creatorコネクタ連携時の注意事項”

ID_RETURNOWFPATH（配置するOWFファイル名）

出力する（アプリケーションサーバに配置する）OWFファイル名をフルパスで指定します。

このキーを指定すると、帳票管理サーバで帳票（OWFファイル）が出力され、アプリケーションサーバへ転送して配置されます。

なお、OWFファイルのファイル名には、全角文字、半角カナ文字、半角空白文字、および以下の半角文字は指定しないでください。

「(」、「)」、「|」、「\」、「^」、「~」、「[」、「]」、「`」、「<」、「>」、「#」、「%」、「"」、「;」、「/」、「?」、「:」、「@」、「&」、「=」、「,」、「*」

ただし、アプリケーションサーバがWindowsの場合、パス名には、「\」、「:」を指定できます。

注意

OWFファイル名の拡張子は必ず「.owf」（半角小文字）を指定してください。「.owf」以外の拡張子を指定した場合、Webプラグインが起動されません。
ID_RETURNPDFPATHキーと同時に指定しないでください。
このキーで指定したファイル名と同一のファイル名がすでに存在する場合はエラーとなります。
このキーを指定する場合、論理デバイスの出力方法にWeb手元印刷のOWF（OWFファイル）を指定してください。また、指定する論理あて先に論理あて先グループは指定しないでください。
帳票管理サーバで生成したOWFファイルをアプリケーションサーバに転送する場合、以下のいずれかで「帳票作成後の出力指定」を「出力する」と指定する必要があります。
- ID_LM_OUTMODEキーに「DO」を指定する
- あらかじめ帳票属性の編集コマンド（lmedtformatrコマンド）の-outputmodeオプションに「1」を指定しておく
- あらかじめ論理あて先の編集コマンド（lmedtldコマンド）の-outputmodeオプションに「1」を指定しておく

ポイント

OWFファイルのアクセス権は、以下のように設定されます。

アプリケーションサーバがWindowsの場合

      OWFファイルが格納されるフォルダのアクセス権が引き継がれます。

アプリケーションサーバがSolaris/Linuxの場合

      owner:rootおよびアクセス権は666となります。

List Creatorコネクタ連携時、アプリケーションサーバから帳票管理サーバにファイルを転送するときに指定可能なファイルパス長については、以下を参照してください。
⇒“4.10.3 List Creatorコネクタ連携時の注意事項”

ID_RETURNXLSPATH（生成するExcelファイル名）: このキーは未サポートです。

ID_REMOTEOPTION（リモート帳票出力オプション）: このキーは未サポートです。

ID_REMOTEMODE（リモート帳票出力モード）: このキーは未サポートです。

●Excelファイル出力情報に関するキー

ID_KEEPXLSX（Excelファイル出力時の格納先ファイル名）: このキーは未サポートです。

ID_XLSX_DOCENVFILE（Excel文書情報ファイル名）: このキーは未サポートです。

ID_XLSX_OUTPUTFORM（Excelファイル出力時の明細の出力方法）: このキーは未サポートです。

ID_XLSX_SHEETNAME（出力するExcelファイルのシート名指定）: このキーは未サポートです。

ID_XLSX_SHEETNAMEITEM（出力するExcelファイルのシート名にする入力データの項目名指定）: このキーは未サポートです。

ID_XLSX_OUTINFOFILE（ECM情報ファイル名）: このキーは未サポートです。

●TIFF出力情報に関するキー

ID_KEEPTIFF（TIFF出力時の格納先ファイル名）: このキーは未サポートです。

●その他

Javaインタフェースのキーやメソッドでサポートされていない、prprintコマンドのオプションの指定に関するキーについて説明します。

ID_EXECBUFFER（帳票出力オプション）

Javaインタフェースのキーやメソッドでサポートされていないprprintコマンドのオプション（PDFファイル保存情報（メール配信）に関するオプションなど）を指定します。

prprintコマンドのオプションについては、以下を参照してください。

⇒“3.3.1 prprintコマンド”

注意

List Creatorコネクタ連携時、アプリケーションサーバからPDFメール配信情報ファイルを転送する場合、ID_LCFILEキーとこのキーで指定するprprintコマンドの-gpdfmailconffileオプションで指定します。その場合、ID_LCFILEキーにはフルパス名を指定し、-gpdfmailconffileオプションではファイル名のみ指定してください。
このキーで設定した値は直列化されません。

4.7.5.6 メソッドの詳細

PrintPropertiesクラスを使用して帳票を出力する場合、帳票の出力に関する各属性をsetPropertyメソッドのキーと値で指定することを推奨します。setPropertyメソッドのキーと値を使用すると、ユーザアプリケーションの記述が分かりやすくなります。このため、ユーザアプリケーションの品質が安定したり、メンテナンスが簡単になったりする効果があります。

以下に、setPropertyメソッドの詳細について説明します。

public void

setProperty(int key, String val)

throws ConnectorException

用途

帳票出力時に指定するプロパティのID キーと値のセットを指定します。

パラメータ

指定できるパラメータのキーと値については、以下を参照してください。
⇒“4.7.5.5 setPropertyメソッドで指定するキーと値”

例外

ConnectorException

注意

このメソッドを指定する場合は、値に「null」を指定しないでください。「null」を指定した場合はエラーになります。

●List Manager管理情報に関するメソッド

public void

setLogicalDestination(String logicaldestination)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

List Managerで使用する論理あて先名または論理あて先グループ名を指定します。

このメソッドが指定されていた場合、List Managerで帳票配信・出力を行います。

List Managerで帳票配信・出力する場合は必ず指定してください。

パラメータ

logicaldestination：: List Managerで使用する論理あて先名または論理あて先グループ名を80バイト以内で指定します。

例外

ConnectorException

public void

setRequestTerminal(String terminal)

ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の作成依頼元を指定します。

帳票の作成依頼元とは、帳票出力の指示を出した端末などを意味します。

このメソッドを指定すると、依頼元端末をキーにして、帳票管理機能で帳票の絞り込みができます。

このメソッドの呼び出しを省略すると、帳票登録を行った帳票管理サーバのホスト名が有効になります。

パラメータ

terminal：

帳票の作成依頼元を255バイト以内で指定します。

帳票の作成依頼元とは、帳票出力の指示を出した端末などを意味します。

タブは指定しないでください。

例外

ConnectorException

public void

setCreateUser(String user)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

List Managerで帳票を作成するユーザ名を指定します。

ユーザ名を指定すると、そのユーザ名をキーに帳票管理機能で帳票の管理や帳票の絞り込みなどができます。

このメソッドの呼び出しを省略すると、デフォルトユーザ名（lmuser）が有効になります。

パラメータ

user：

List Managerで帳票を作成するユーザ名を16バイト以内で指定します。

タブは指定しないでください。

例外

ConnectorException

public void

setOutMode(int outmode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

List Managerで帳票を作成後、そのまま続けて配信して出力するかどうか（帳票の登録のみ行うかどうか）を指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

論理あて先の編集コマンド（lmedtldコマンド）で設定した帳票作成後の出力指定
帳票属性の編集コマンド（lmedtformatrコマンド）で設定した帳票作成後の出力指定

パラメータ

outmode：

List Managerで帳票を作成後、そのまま続けて配信して出力するかどうかを指定します。

OUTMODE_DO：: 出力します。

OUTMODE_NONE：: 出力しません（帳票の登録のみ行います）。

例外

ConnectorException

備考

List Creatorコネクタ連携時、アプリケーションサーバに帳票（PDFファイルまたはOWFファイル）を配置する場合は、このメソッドで「OUTMODE_DO」を指定する必要があります。
このメソッドで「OUTMODE_NONE」を指定した場合、以下の方法で出力できます。
- List Managerの帳票一覧画面から出力する
- List Manager の帳票ブラウザの出力指示画面から出力する
- 帳票の出力/出力中止コマンド（lmoprprintコマンド）を使用して出力する
- 帳票管理Javaインタフェースを使用して出力する
このメソッドで「OUTMODE_NONE」（登録のみ行う）を指定した場合、帳票の総ページ数が表示/取得されないことがあります。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

public void

setKeepMode(int keepmode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

List Managerで帳票を出力後、保存するかどうかを指定します。

このメソッドは、帳票配信用の論理あて先に出力する場合のみ有効になります。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

論理あて先の編集コマンド（lmedtldコマンド）で設定した帳票出力後の保存指定
帳票属性の編集コマンド（lmedtformatrコマンド）で設定した帳票出力後の保存指定

パラメータ

keepmode：

List Managerで帳票を出力後、保存するかどうかを指定します。

KEEPMODE_DO：: 保存します。

KEEPMODE_NONE：: 保存しません。

例外

ConnectorException

注意

Web 手元印刷型の場合、このメソッドの指定は無効となり、必ず帳票出力後に帳票が保存されます。したがって、保存日数はsetKeepDaysメソッドで指定することができます。
このメソッドで「KEEPMODE_NONE」を指定した場合、帳票の出力が完了した時点で削除されます。

public void

setKeepDays(int days)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

List Managerで帳票を保存する日数を指定します。

このメソッドは、帳票出力後の保存指定で「KEEPMODE_DO」（保存する）を指定した場合のみ有効となります。

Web 手元印刷型の場合、帳票出力後の保存指定は無効となりますが、「KEEPMODE_DO」（保存する）が指定されたものとみなされるため、保存日数の指定は有効になります。

帳票出力後の保存指定は、以下のいずれかの方法で指定します。

setKeepModeメソッド
帳票属性の編集コマンド（lmedtformatrコマンド）
論理あて先の編集コマンド（lmedtldコマンド）

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

論理あて先の編集コマンド（lmedtldコマンド）で設定した保存日数の指定
帳票属性の編集コマンド（lmedtformatrコマンド）で設定した保存日数の指定

パラメータ

days：

List Manager で帳票を保存する日数を以下の範囲で指定します。

0：: 帳票を無期限に保存します。

1～9999：: 帳票を保存する日数を指定します。

例外

ConnectorException

備考

帳票の保存期限は、「保存期限＝作成日＋保存日数－1」で計算されます。保存日数に「1」を指定した場合は、「保存期限＝作成日」となります。
保存期限が設定された帳票を削除する場合は、保存期限を経過した帳票の削除コマンド（lmdelexpireコマンド）を使用してください。

●ユーザ資源情報に関するメソッド

public void

setBarCodeData(int barcode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

バーコードCODE128、EAN-128の入力データのエンコード方法を指定します。

このメソッドの呼び出しを省略すると、「BARDATA_NONE」が指定されたものとして動作します。

パラメータ

barcode：

バーコードCODE128、EAN-128の入力データのエンコード方法を指定します。

BARDATA_NONE：: CODE128、EAN-128の入力データにエンコードしないデータを指定します。

BARDATA_BASE64：: CODE128、EAN-128の入力データにBASE64エンコードしたデータを指定します。

例外

ConnectorException

注意

このメソッドを指定する場合は、帳票設計時に対象となるバーコード項目（CODE128、EAN-128）に、以下の設定をしてください。
- 対象となるバーコード項目のプロパティの［プロパティ］タブの項目長
- BASE64エンコードする前のバーコードデータの長さに+2した長さ
- List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目のバイト数（入力データ形式が「固定長」の場合）
- BASE64エンコードした後のバイト数
以下の場合、このメソッドに「BARDATA_BASE64」を指定しないでください。
- List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブの該当するデータ項目にオペランドを指定した場合
- List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのオペランドに該当するデータ項目名を指定した場合
- List Creatorデザイナのデータ定義画面の［拡張定義］タブに該当するデータ項目名を指定した場合

public void

setVisualDir(java.lang.String visualdir)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

メディアデータ格納ディレクトリを以下の範囲で指定します。

帳票配信型の場合（帳票出力サーバのフルパス）
250バイト以内で指定します。
Web手元印刷型（PDFファイル形式）の場合（帳票管理サーバのフルパス）
- 帳票管理サーバがWindowsの場合
  250バイト以内で指定します。
- 帳票管理サーバがSolaris/Linuxの場合
  512バイト以内で指定します。

また、List Creatorコネクタ連携時のメディアデータ格納ディレクトリについても、上記の範囲で指定します。

このメソッドで指定するディレクトリパスは、帳票出力先の環境で有効となります。

組込みメディア項目のデータがファイル名のみの場合、このメソッドで指定したメディアデータ格納ディレクトリ配下を検索します。

複数のメディアデータ格納ディレクトリを指定する場合は、ディレクトリ名を「セミコロン（;）」で区切って指定します。

指定した複数のディレクトリ配下に同一名のメディアデータがある場合は、先に指定したディレクトリ配下のメディアデータが有効になります。

このメソッドの呼び出しを省略した場合、またはここで指定したディレクトリ配下にメディアデータが見つからない場合は、以下のディレクトリが有効になります。

帳票配信型の場合
帳票出力サーバの環境設定ファイルのLmlcMediaDir キーで指定したディレクトリ
Web手元印刷型（PDFファイル形式）の場合
帳票管理サーバの環境設定ファイルのLmlcMediaDir キーで指定したディレクトリ

パラメータ

visualdir：: メディアデータ格納ディレクトリをフルパスで指定します。

例外

ConnectorException

注意

帳票一覧画面、または帳票ブラウザで組込みメディア項目が定義された帳票をプレビューする場合、必ずPrintPropertiesクラスのsetPropertyメソッドのID_CMVISUALFILEキーでメディアデータファイル名を指定してください。
Web手元印刷型（OWFファイル形式）の場合、このメソッドは無効になります。
帳票配信型の場合、メディアデータ格納ディレクトリ名の末尾には、「円マーク（\）」を指定しないでください。
Web手元印刷型（PDF ファイル形式）の場合、メディアデータ格納ディレクトリ名の末尾には、以下を指定しないでください。
- 帳票管理サーバがWindowsの場合
  「円マーク（¥）」
- 帳票管理サーバがSolaris/Linuxの場合
  「スラッシュ（/）」
帳票管理サーバがWindowsの場合、メディアデータ格納ディレクトリとして、ネットワークドライブ（UNC 指定（¥¥コンピュータ名¥共有名¥ディレクトリ名）を除く）、およびリムーバブルディスクを指定しないでください。

●識別情報に関するメソッド

public void

setTitle(java.lang.String title)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

タイトルを指定します。

このメソッドの呼び出しを省略すると、帳票名が帳票のタイトルになります。

パラメータ

title：: タイトルを64バイト以内で指定します。

例外

ConnectorException

注意

PDFファイル保存する場合、タイトルは、日本語（JIS 非漢字/ 第一水準漢字/第二水準漢字）または英数字で指定してください。その他の文字を指定した場合、PDFファイルの文書情報（一般）で正しく表示されないことがあります。
環境変数LANGおよびList Manager管理データベースの文字コード系によって、実際に指定したバイト数よりList Manager管理データベースに登録される文字列のバイト数が短くなることがあります。詳細については、以下を参照してください。
⇒“C.1 List Managerで扱える文字コード系”

備考

タイトルに指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

public void

setComment(java.lang.String comment)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票に関するコメントを指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

帳票属性の編集コマンド（lmedtformatrコマンド）で指定したコメント
設定されない

パラメータ

comment：: 帳票に関するコメントを64バイト以内で指定します。

例外

ConnectorException

注意

環境変数LANGおよびList Manager管理データベースの文字コード系によって、実際に指定したバイト数よりList Manager管理データベースに登録される文字列のバイト数が短くなることがあります。詳細については、以下を参照してください。
⇒“C.1 List Managerで扱える文字コード系”

備考

コメントに指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

●動作情報に関するメソッド

public void

setStartPage(int page)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

出力を開始するページ番号を指定します。

帳票の総ページ数以下の値、および終了ページ番号（setEndPageメソッド）以下の値を指定してください。

このメソッドの呼び出しを省略すると、1ページ目から出力を開始します。

パラメータ

page：: 出力を開始するページ番号を指定します。

例外

ConnectorException

備考

このメソッドを指定した場合、以下に表示される帳票の総ページ数は指定した範囲のページ数となります。
- List Managerの帳票一覧画面
- List Managerの詳細表示画面
- List Manager の帳票ブラウザの帳票詳細表示画面
- 帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
- 帳票管理Javaインタフェースでの取得結果
- 帳票のページ数については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

public void

setEndPage(int page)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

出力を終了するページ番号を指定します。

帳票の総ページ数より大きな値を指定した場合、帳票の最終ページまで出力されます。

開始ページ番号（setStartPageメソッド）以上の値を指定してください。

このメソッドの呼び出しを省略すると、最終ページまで出力します。

パラメータ

page：: 出力を終了するページ番号を指定します。

例外

ConnectorException

備考

このメソッドを指定した場合、以下に表示される帳票の総ページ数は指定した範囲のページ数となります。
- List Managerの帳票一覧画面
- List Managerの詳細表示画面
- List Manager の帳票ブラウザの帳票詳細表示画面
- 帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
- 帳票管理Javaインタフェースでの取得結果
- 帳票のページ数については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

public void

setDirectMethod(int outputmode)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setOutputMode(int outputmode)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setReplaceString(java.lang.String string)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

SET演算子の置換文字列を指定します。

SET演算子に変数「%」を指定した場合は、このメソッドで置換文字列を必ず指定してください。

パラメータ

string：

SET演算子の置換文字列を指定します。

指定形式については、以下を参照してください。
⇒List Creatorのオンラインマニュアル“環境設定・帳票運用編”

例外

ConnectorException

備考

マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）は、使用するすべての帳票に対してこのメソッドで指定した同じ置換文字列が有効になります。

public void

setOutputScale(int size)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

指定した用紙サイズに合わせて帳票を拡大または縮小して出力したい場合に、出力したい用紙サイズを指定します。

指定された用紙サイズが定義された用紙サイズよりも大きい場合は、指定された用紙サイズに拡大されます。指定された用紙サイズが定義された用紙サイズよりも小さい場合は、指定された用紙サイズに縮小されます。なお、拡大または縮小を行った場合、横幅と縦幅の比率は保たれます。

用紙サイズに合わせた拡大/縮小指定は、以下の優先順序で有効になります。

プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定した用紙サイズ
このメソッドで指定した用紙サイズ
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブの拡大/縮小指定

パラメータ

size：

指定した用紙サイズに合わせて帳票を拡大または縮小して出力したい場合に、出力したい用紙サイズを指定します。

OUTPUTSCALE_A3：: A3用紙

OUTPUTSCALE_A4：: A4用紙

OUTPUTSCALE_A5：: A5用紙

OUTPUTSCALE_A6：: A6用紙

OUTPUTSCALE_B4：: B4用紙

OUTPUTSCALE_B5：: B5用紙

OUTPUTSCALE_PS：: はがき

OUTPUTSCALE_LT：: Letter

OUTPUTSCALE_LG：: Legal

例外

ConnectorException

注意

以下の場合、用紙サイズのみ有効になり、拡大/縮小指定は無効になります。
- 拡大/縮小がサポートされていないプリンタを使用した場合
このメソッドは、出力方法が印刷、PDFファイル保存の場合、および電子保存した帳票を印刷する場合のみ有効になります。電子保存した帳票を表示する場合は無効になります。
電子保存は、Interstage List Manager互換のための機能です。

public void

setStartPosition(int gridunit, float startposx, float startposy)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票出力時の原点位置を指定します。

原点位置の指定は、以下の優先順序で有効になります。

論理デバイスの編集コマンド（lmedtdevコマンド）で指定した原点位置
このメソッドで指定した原点位置
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［余白］タブで指定した原点位置

パラメータ

gridunit：

帳票出力時の原点位置をインチ単位またはミリ単位で指定します。

SETSTARTPOS_INCH：: インチ単位で指定します。

SETSTARTPOS_MM：: ミリ単位で指定します。

startposx：

印刷開始時の横方向の位置を指定します。

0.00～22.50：: インチ単位指定の場合

0.0～571.5：: ミリ単位指定の場合

startposy：

印刷開始時の縦方向の位置を指定します。

0.00～22.50：: インチ単位指定の場合

0.0～571.5：: ミリ単位指定の場合

例外

ConnectorException

注意

このメソッドは、出力方法が印刷、PDFファイル保存の場合、および電子保存した帳票を印刷する場合のみ有効になります。電子保存した帳票を表示する場合は無効になります。
電子保存は、Interstage List Manager互換のための機能です。

public void

setLFCode(int mode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

入力データ形式が「可変長」、「固定長」、または「CSV形式」で、入力データ中に改行コードのみの行が存在した場合の制御方法を指定します。

このメソッドの呼び出しを省略すると、「LFCODE_SKIP」が指定されたものとして動作します。

パラメータ

mode：

入力データ形式が「可変長」、「固定長」、または「CSV形式」で、入力データ中に改行コードのみの行が存在した場合の制御方法を指定します。

LFCODE_DO: 改行コードのみの行は改行処理だけを行います。空の1行が出力されます。

LFCODE_SKIP: 改行コードのみの行は読み飛ばします。改行コードがなかったものとして動作します。

例外

ConnectorException

注意

このメソッドは、入力データ形式が「可変長」、「固定長」、および「CSV形式」の場合に有効です。「XML形式」の場合はエラーになります。
このメソッドは、以下の帳票形式を使用する際のメソッドです。
- フリーフレーム形式
- 集計表形式
- 伝票形式
- 矩形繰返し形式
- タックシール形式
- カード形式の場合、このメソッドで「LFCODE_DO」（改行コードのみの行は改行処理だけを行う指定）を指定しないでください。指定した場合、入力データが出力されない空ページが出力されることになります。
このメソッドで「LFCODE_DO」（改行コードのみの行は改行処理だけを行う指定）を指定した場合、List Creatorデザイナのデータ定義画面の［データ定義］タブのデータ項目のオペランドに「BREAK」を指定すると、意図しない動作（データのある行と改行コードのみの行でBREAKが発生したことになる）になります。

備考

改行コードは、以下のとおりです。
- 帳票管理サーバがWindowsの場合
  0x0D0Aまたは0x0A
- 帳票管理サーバがSolaris/Linuxの場合
  0x0A

public void

setFFCode(int mode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

入力データ形式が「可変長」、「固定長」、または「CSV形式」の場合、入力データ中の改ページコードの制御方法を指定します。

このメソッドの呼び出しを省略すると、「FFCODE_NONE」が指定されたものとして動作します。

パラメータ

mode：

入力データ形式が「可変長」、「固定長」、または「CSV形式」の場合、入力データ中の改ページコードの制御方法を指定します。

FFCODE_DO：: 改ページ処理を行います（次のレコードは次ページより出力します）。

FFCODE_SKIP：

改ページ処理を行わず、改ページコードは読み飛ばします。

改ページコードがなかったものとして動作します。

FFCODE_NONE：: 改ページ処理および改ページコードの読み飛ばしを行いません。改ページコードを意識せずに入力データの読み込みを行うため、改ページコードが含まれると、不当な文字が出力されることがあります。

例外

ConnectorException

注意

このメソッドは、入力データ形式が「可変長」、「固定長」、および「CSV形式」の場合に有効です。「XML形式」の場合はエラーになります。
このメソッドは、以下の帳票形式を使用する際のメソッドです。
- フリーフレーム形式
- 集計表形式
- 伝票形式
- 矩形繰返し形式
- タックシール形式
- カード形式の場合、このメソッドで「FFCODE_DO」（改ページ処理を行う指定）を指定しないでください。指定した場合、入力データが出力されない空ページが出力されることになります。カード形式で改ページコードを含んだ入力データを使用する場合は、このメソッドで「FFCODE_SKIP」を指定してください。

備考

改ページコードの前には、改行コードは、あってもなくても構いません。
改ページコードは、以下のとおりです。
- 帳票管理サーバがWindowsの場合
  0x0D0Cまたは0x0C
- 帳票管理サーバがSolaris/Linuxの場合
  0x0C
改行コードは、以下のとおりです。
- 帳票管理サーバがWindowsの場合
  0x0D0Aまたは0x0A
- 帳票管理サーバがSolaris/Linuxの場合
  0x0A

public void

setNoData(boolean nodata)

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

入力データ（項目）が0バイトの場合に、エラーとなるかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、「false」が指定されたものとして動作します。

パラメータ

nodata：

入力データ（項目）が0バイトの場合に、エラーとなるかどうかを指定します。

false：: エラーとします。

true：

エラーとせず出力します。

入力データ（項目）が0バイトの場合もエラーになりません。

その場合、0バイトの項目は、以下のように出力されます。

テキスト項目：: 出力されません（空白になります）。

数字項目：: 0が出力されます。

OCR-B項目：: 出力されません（空白になります）。

ラジオボタン項目：: 選択されません。

チェックボックス項目：: 選択されません。

バーコード項目：: 出力されません（空白になります）。

組込みメディア項目：: 出力されません（空白になります）。

郵便番号項目：: 出力されません（空白になります）。

矩形テキスト項目：: 出力されません（空白になります）。

注意

入力データ形式が「XML形式」の場合、このメソッドは指定しないでください。

備考

入力データ（項目）が0バイトでない場合の動作は、以下のとおりです。
- 「false」を指定した場合
  数字項目以外は、このメソッドで「true」を指定した場合と同じ出力動作となります。数字項目は、空白となります。
- 「true」を指定した場合
  このメソッドの出力と同じ出力動作となります。
マルチフォーム出力時、入力データ（項目）が0バイトの状態とは、以下の条件をすべて満たす状態を指します。
- 帳票名およびマルチフォーム用帳票名データ区切り文字が記述されている
- レコードには帳票名に続くデータが存在しない
- 同一の帳票名に対してレコードが連続していない
  レコードが連続している場合は、入力データにレコードが存在すると判断するため、
  このメソッドの動作指定は1レコード目にのみ有効になりますが、以降のレコードは通常の帳票出力時の印刷動作になります。

●印刷情報に関するメソッド

public void

setPrtDevName(java.lang.String prtdevname)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setPrinter(java.lang.String printer)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setPrintBin(int bin)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setPrintBinName(java.lang.String binname)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setItemPrintBin(java.lang.String bin)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

用紙種別が「単票」で、マルチフォーム出力する（FormsクラスのChangeFormメソッドを指定した、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した）場合に、帳票を切り替えたときに給紙方法/給紙口名も切り替える（各帳票で指定した給紙方法/給紙口名を有効にする）かどうかを指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

プリンタ構成の編集コマンド（lmedtprinfoコマンド）で指定した給紙口名
List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した給紙方法/給紙口名

パラメータ

bin：

!REPORT：: 各帳票で指定した給紙方法/給紙口名を有効にします。

例外

ConnectorException

注意

指定した給紙方法で給紙されない場合は、給紙口名をList Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定し、このメソッドを指定してください。
プリンタの段組み印刷機能を使用する場合、このメソッドを指定しないでください。指定した場合、正しく動作しません。
プリンタによっては、帳票ごとに給紙方法/給紙口名を切り替えられないものもあります。必ず、実際に使用するプリンタで動作確認してください。

public void

setCopyNumber(int copies, boolean collate)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の印刷部数、および部単位で印刷するかどうかを指定します。

copiesパラメータを指定し、collateパラメータに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した印刷部数の指定が有効になります。

パラメータ

copies：: 帳票の印刷部数を1～999の範囲で指定します。

collate：

部単位で印刷するかどうかを指定します。

true：: 部単位で印刷します。

false：: 部単位で印刷しません。

例外

ConnectorException

注意

部単位の指定は、以下の場合に有効です。
- List Works Print Agentで印刷する場合
- List Works Workstationで、出力装置にPrint Managerで定義したプリンタを指定した場合
プリンタドライバのプロパティで印刷部数が指定できないプリンタに出力する場合、以下のように動作します。
- 部単位で印刷する指定をしないとき（collateパラメータに「false」を指定するとき）、印刷部数を指定していても無効になります（1部だけ印刷されます）。
- 部単位で印刷する指定をしたとき（collateパラメータに「true」を指定するとき）、印刷部数の指定は有効になります。
List Creatorデザイナの帳票業務情報のプロパティ画面で指定された部数は、以下では表示されません。
- List Managerの詳細表示画面
- 帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
- 帳票管理Javaインタフェースでの取得結果
List Works Workstationで、印刷プリンタ名にPrint Managerで定義したプリンタ以外を指定した場合は、collateに「true」を指定しないでください。指定した場合、印刷部数の指定は無効になります（1部だけ印刷されます）。
このメソッドで印刷部数を指定した場合、帳票のページ数について注意が必要です。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

public void

setPrintSide(int printside)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

以下について指定します。

両面印刷するかどうか
マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか

印刷面指定は、以下の優先順序で有効になります。

setItemPrintSideメソッドの指定にしたがった両面印刷と、マルチフォーム出力時に帳票を切り替えたときに新しい用紙に印刷する指定
このメソッドで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

パラメータ

printside：

以下について指定します。

両面印刷するかどうか
マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか

PRINTSIDE_SINGLEFOLLOW：

片面印刷します。

マルチフォーム出力をする場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

PRINTSIDE_BOTHFOLLOW：

両面印刷します。

マルチフォーム出力をする場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

PRINTSIDE_SINGLE：

片面印刷します。

マルチフォーム出力をする場合は、帳票を切り替えたときに新しい用紙に印刷します。

PRINTSIDE_BOTH：

両面印刷します。

マルチフォーム出力をする場合は、帳票を切り替えたときに新しい用紙に印刷します。

例外

ConnectorException

注意

使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
List Creator デザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
以下の場合、このメソッドに「PRINTSIDE_SINGLE」、「PRINTSIDE_BOTH」を指定しないでください。指定した場合、正しく動作しません。
- プリンタの段組み印刷機能を使用する場合
- プリンタの白紙の出力を抑止する機能を使用する場合
このメソッドで印刷面を指定した場合、帳票のページ数について注意が必要です。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

備考

List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目にPAGE 、TPAGE 、PAGE-ALL 、TPAGE-ALL 、BPAGE、またはBTPAGE のいずれかを指定した項目が存在する帳票で、このメソッドに「PRINTSIDE_SINGLE」または「PRINTSIDE_BOTH」を指定する場合、印刷せずにページ送りされた分はカウントされません。

public void

setItemPrintSide(java.lang.String printside)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

setPrintSideメソッドで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブで指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

パラメータ

printside：

!REPORT：: 各帳票で指定した印刷面指定を有効にします。

例外

ConnectorException

注意

使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
List Creator デザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
プリンタの段組み印刷機能を使用する場合、このメソッドを指定しないでください。指定した場合、正しく動作しません。
プリンタによっては、帳票ごとに印刷面を切り替えられないものもあります。必ず、実際に使用するプリンタで動作確認してください。
このメソッドで印刷面切り替えを指定した場合、帳票のページ数について注意が必要です。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“付録B 帳票のページ数について”を参照してください。

●電子保存情報に関するメソッド

注意

電子保存情報に関するメソッド、およびList Creatorデザイナの帳票業務情報のプロパティ画面で指定された電子保存情報は、以下では表示されません。

List Managerの帳票一覧画面
List Managerの詳細表示画面
List Manager の帳票ブラウザの帳票詳細表示画面
帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）の一覧表示結果
帳票管理Javaインタフェースでの取得結果

ポイント

電子保存情報に関するメソッドは、Interstage List Manager互換のための機能で使用するメソッドです。

public void

setListDrvName(java.lang.String drivename)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setListMaker(java.lang.String maker)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の作成者を指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブで指定した作成者
設定されない

パラメータ

maker：: 帳票の作成者を64バイト以内で指定します。

例外

ConnectorException

public void

setListGenerateDay(java.lang.String generateday)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の作成日を指定します。

作成日と作成時間の指定の関係については、以下を参照してください。
⇒“B.1 電子保存時の作成日時”

パラメータ

generateday：

帳票の作成日をYYYYMMDDの形式で指定します。

YYYY：: 年を西暦で指定します。

MM：: 01～12（月）の範囲で指定します。

DD：: 01～31（日）の範囲で指定します。

例外

ConnectorException

public void

setListGenerateTime(java.lang.String generatetime)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の作成時間を指定します。

作成日と作成時間の指定の関係については、以下を参照してください。
⇒“B.1 電子保存時の作成日時”

パラメータ

generatetime：

帳票の作成時間をHHmmの形式で指定します。

HH：: 00～23（時）の範囲で指定します。

mm：: 00～59（分）の範囲で指定します。

例外

ConnectorException

public void

setListKeepDir(java.lang.String path)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票を電子保存するリスト管理サーバ上の保管フォルダのディレクトリ名を指定します。

このメソッドの呼び出しを省略すると、論理デバイスの編集コマンド（lmedtdev コマンド）で指定した保管フォルダパス名が有効になります。

パラメータ

path：

以下の半角文字は指定しないでください。

「/」、「,」、「;」、「*」、「?」、「"」、「<」、「>」、「|」

例外

ConnectorException

注意

保管フォルダパス名の末尾には、以下を指定しないでください。
```
「円マーク（\）」
```
以下のいずれかに保管フォルダが指定されていた場合、指定した場所に帳票が電子保存されるため、List Worksで指定した振り分け条件が無効になります。
- setListKeepDirメソッド
- 論理デバイスの編集コマンド（lmedtdevコマンド）
- List Worksの振り分け条件を有効にしたい場合は、上記の保管フォルダの指定をすべて省略する必要があります。

public void

setListNote1(java.lang.String note1)

throws ConnectorException

public void

setListNote2(java.lang.String note2)

throws ConnectorException

public void

setListNote3(java.lang.String note3)

throws ConnectorException

public void

setListNote4(java.lang.String note4)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の備考1～4を指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した備考1～4
設定されない

パラメータ

note1：: 帳票の備考1を64バイト以内で指定します。

note2：: 帳票の備考2を64バイト以内で指定します。

note3：: 帳票の備考3を64バイト以内で指定します。

note4：: 帳票の備考4を64バイト以内で指定します。

例外

ConnectorException

public void

setListTerm(int days)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票をリスト管理サーバに登録した日からの有効期限日数を指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した有効期限日数が有効になります。

パラメータ

days：

帳票をリスト管理サーバに登録した日からの有効期限日数を0～9999の範囲で指定します。

0：: リスト管理サーバの保管フォルダの設定にしたがいます。

1～9999：: 有効期限日数を指定します。

例外

ConnectorException

public void

setListDelType(boolean deltype)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票をリスト管理サーバに登録した日から有効期限を過ぎた場合に、リストクリーナの削除対象とするかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した有効期限の「有効期限を過ぎたら自動削除する」の指定が有効になります。

パラメータ

deltype：

帳票を有効期限経過後にリストクリーナの削除対象とするかどうかを指定します。

true：: 削除対象とします。

false：: 削除対象としません。

例外

ConnectorException

注意

このメソッドを指定する場合は、以下のいずれかで有効期限日数を指定しておく必要があります。
- List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面の有効期限の日数
- setListTerm メソッド

public void

setListSearch(int search)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

電子保存時に帳票の抜き出し検索を有効にするかどうかを指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した抜き出し検索の指定が有効になります。

パラメータ

search：

電子保存時に帳票の抜き出し検索を有効にするかどうかを指定します。

LISTSEARCH_FOLDER：: リスト管理サーバの保管フォルダの設定にしたがいます。

LISTSEARCH_FALSE：: 抜き出し検索を有効にしません。

LISTSEARCH_TRUE：: 抜き出し検索を有効にします。

例外

ConnectorException

注意

抜き出し検索を有効にする場合は、あらかじめリスト管理サーバに登録されている帳票で抜き出し検索範囲を指定しておく必要があります。

備考

抜き出し検索とは、あらかじめ設定されている検索範囲（抜き出し検索範囲）に対して、文字列を高速に検索する機能です。定型的な検索を大量に行う場合に適しています。
List Worksでは、電子保存した帳票のデータを検索できます。抜き出し検索を有効にすると、より高速に検索できます。

public void

setListMail(int mail)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票がリスト管理サーバに登録されたことをメールで通知するかどうかを指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定したメール送信の指定が有効になります。

パラメータ

mail：

帳票がリスト管理サーバに登録されたことをメールで通知するかどうかを指定します。

LISTMAIL_SERVER：: リスト管理サーバの設定にしたがいます。

LISTMAIL_FALSE：: リスト管理サーバに帳票が登録されたことをメールで送信しません。

LISTMAIL_ENTRY：: リスト管理サーバに帳票が登録されたことをメールで送信します。送信時には、帳票エントリファイルを添付して送信します。

LISTMAIL_FILE：: リスト管理サーバに帳票が登録されたことをメールで送信します。送信時には、帳票ファイルを添付して送信します。

例外

ConnectorException

備考

帳票エントリファイルを指定する（mailパラメータに「LISTMAIL_ENTRY」を指定する）と、電子保存時に帳票の管理情報だけがメール送信されます。したがって、送信されるメールのサイズは帳票ファイルの場合よりも小さくなります。ただし、このファイルをList Worksクライアントで受信した場合、実際に帳票を表示するためには、リスト管理サーバに接続する必要があります。
帳票ファイルを指定する（mailパラメータに「LISTMAIL_FILE」を指定する）と、電子保存時に帳票そのものがメール送信されます。このファイルをList Worksクライアントで受信した場合、帳票をそのまま表示できますが、送信されるデータ量は大きくなります。

public void

setListMailRcv(java.lang.String address)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

電子保存時に帳票がリスト管理サーバに登録されたことを通知するメールの宛先を指定します。宛先は、リスト管理サーバで設定されているメール環境にしたがって指定してください。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面で指定した宛先
リスト管理サーバで設定されている宛先

パラメータ

address：: 電子保存時に帳票がリスト管理サーバに登録されたことを通知するメールの宛先を64バイト以内で指定します。

例外

ConnectorException

注意

このメソッドを指定する場合は、以下のいずれかでメール送信する指定にしておく必要があります。
- List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存の詳細設定画面のメール送信
- setListMailメソッド（「LISTMAIL_ENTRY」または「LISTMAIL_FILE」を指定する）

public void

setListPrintBin(int bin)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

電子保存後の印刷で、用紙種別が「単票」の場合に、印刷プリンタの給紙方法を指定します。

給紙方法は、以下の優先順序で有効になります。

setListPrintBinNameメソッドで指定した給紙口名
このメソッドで指定した給紙方法
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した給紙方法/給紙口名

パラメータ

bin：

電子保存後の印刷で、用紙種別が「単票」の場合に、印刷プリンタの給紙方法を指定します。

LISTBIN_CF：: カットシートフィーダ

LISTBIN_H1：: ホッパ1

LISTBIN_H2：: ホッパ2

LISTBIN_H3：: ホッパ3

LISTBIN_H4：: ホッパ4

LISTBIN_MA：: 手差し

LISTBIN_NO：: 指定なし（プリンタドライバのプロパティの設定にしたがいます）

LISTBIN_AT：: 自動

例外

ConnectorException

注意

指定した方法で給紙されない場合は、給紙口名をsetListPrintBinNameメソッドで指定してください。
このメソッドで給紙方法を切り替えた場合、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した給紙口名は無効になります。必要に応じて、給紙口名をsetListPrintBinNameメソッドで指定してください。
給紙方法に「LISTBIN_NO」（指定なし）または「LISTBIN_AT」（自動）を指定した場合、給紙口名をsetListPrintBinNameメソッドで指定しても無効になります。給紙口名を指定する場合は、「LISTBIN_NO」（指定なし）または「LISTBIN_AT」（自動）以外を指定してください。
給紙方法を指定せずに給紙口名をsetListPrintBinNameメソッドで指定した場合、給紙口名の指定は無効になります。
給紙方法に「LISTBIN_AT」（自動）を指定しても自動給紙が正しく動作しない場合は、プリンタドライバのプロパティで自動給紙を指定し、給紙方法に「LISTBIN_NO」（指定なし）を指定してください。
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。

public void

setListPrintBinName(java.lang.String binname)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

電子保存後の印刷で、以下の場合に、出力先のプリンタの給紙口名を指定します。指定できる給紙口名は、プリンタドライバのプロパティで確認してください。

用紙種別が「単票」で、給紙方法で指定した給紙口に切り替わらない場合
用紙種別が「連帳」で、給紙口が正常に切り替わらない場合

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

setListPrintBinメソッドで指定した給紙方法
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した給紙方法/給紙口名

パラメータ

binname：: 電子保存後の印刷で、出力先のプリンタの給紙口名を32 バイト以内で指定します。

例外

ConnectorException

注意

給紙口名は、プリンタドライバによって異なります。プリンタドライバのプロパティで確認し、文字および空白の全角・半角の違い、空白の有無などに注意して、正確に指定してください。
給紙方法をsetListPrintBinメソッドで指定せずに給紙口名を指定した場合、給紙口名の指定は無効になります。

public void

setListCopyNumber(int copies, int collate)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

電子保存後の印刷で、帳票の印刷部数、および部単位で印刷するかどうかを指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した印刷部数が有効になります。

パラメータ

copies：: 電子保存後の印刷で、帳票の印刷部数を1 ～9999の範囲で指定します。

collate：

電子保存後の印刷で、部単位で印刷するかどうかを指定します。

LISTCOPY_TRUE：: 部単位で印刷します。

LISTCOPY_FALSE：: ページ単位で印刷します。

LISTCOPY_DEFAULT：: 部単位で印刷するかどうかは装置の設定にしたがいます。

例外

ConnectorException

注意

プリンタドライバのプロパティで印刷部数が指定できないプリンタに出力する場合、以下のように動作します。
- 部単位で印刷する指定をしないとき（collateパラメータに「LISTCOPY_FALSE」を指定するとき）、印刷部数を指定していても無効になります（1部だけ印刷されます）。
- 部単位で印刷する指定をしたとき（collateパラメータに「LISTCOPY_TRUE」を指定するとき）、印刷部数の指定は有効になります。
collateパラメータに「LISTCOPY_DEFAULT」を指定した場合は、印刷部数を指定していても無効になります（1部だけ印刷されます）。

public void

setListPrintSide(int printside)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

電子保存後の印刷で、以下について指定します。

両面印刷するかどうか
マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか

印刷面指定は、以下の優先順序で有効になります。

setListItemPrintSideメソッドの指定にしたがった両面印刷と、マルチフォーム出力時に帳票を切り替えたときに新しい用紙に印刷する指定
このメソッドで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

パラメータ

printside：

電子保存後の印刷で、以下について指定します。

両面印刷するかどうか
マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するか

LISTPRINTSIDE_SINGLEFOLLOW：

片面印刷します。

マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

LISTPRINTSIDE_BOTHFOLLOW：

両面印刷します。

マルチフォーム出力する場合は、帳票を切り替えたときに同じ用紙に続けて印刷します。

LISTPRINTSIDE_BOTH：

両面印刷します。

マルチフォーム出力する場合は、帳票を切り替えたときに新しい用紙に印刷します。

例外

ConnectorException

注意

使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
以下の場合、このメソッドに「LISTPRINTSIDE_BOTH」を指定しないでください。指定した場合、正しく動作しません。
- プリンタの段組み印刷機能を使用する場合
- プリンタの白紙の出力を抑止する機能を使用する場合

備考

List Creatorデザイナのデータ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目にPAGE 、TPAGE 、PAGE-ALL 、TPAGE-ALL 、BPAGE、またはBTPAGE のいずれかを指定した項目が存在する帳票で、このメソッドに「LISTPRINTSIDE_BOTH」を指定した場合、印刷せずにページ送りされた分はカウントされません。

public void

setListItemPrintSide(java.lang.String printside)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

setListPrintSideメソッドで指定した印刷面指定
List Creatorデザイナの帳票業務情報のプロパティ画面の［電子保存］タブの電子保存後の印刷設定画面で指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

パラメータ

printside：

電子保存後の印刷で、マルチフォーム出力し（FormsクラスのChangeFormメソッドを指定した、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した）帳票を切り替えたときに新しい用紙に印刷する指定も切り替える（各帳票で指定した帳票を切り替えたときに新しい用紙に印刷する指定を有効にする）場合に指定します。

!REPORT：: 電子保存後の印刷でマルチフォーム出力する（FormsクラスのChangeFormメソッドを指定した、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した）場合に、帳票を切り替えたときに新しい用紙に印刷する指定を有効にします。

例外

ConnectorException

注意

プリンタの段組み印刷機能を使用する場合、このメソッドを指定しないでください。指定した場合、正しく動作しません。
使用する印刷プリンタに両面印刷機能がない場合、または両面印刷機能が無効になっている場合、両面印刷の指定は無効になります（片面で印刷されたり、白紙が出力されたりする場合があります）。
List Creatorデザイナの帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブで、段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、1番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
帳票が切り替わったときに、両面印刷の指定を切り替えることはできません。
先頭の帳票で指定した両面印刷の指定が有効になります。

public void

setListFaxSend(java.lang.String senddata)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setListFaxRcv(java.lang.String rcvdata)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setListFaxRcvFile(java.lang.String filename)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setListFaxInvoice(java.lang.String subject, java.lang.String comment)

throws ConnectorException

用途

このメソッドは未サポートです。

●FAX送信情報に関するメソッド

public void

setFaxDrvName(java.lang.String drive)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setFaxSend(java.lang.String senddata)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setFaxRcv(java.lang.String rcvdata)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setFaxRcvFile(java.lang.String filename)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setFaxInvoice(java.lang.String subject, java.lang.String comment)

throws ConnectorException

用途

このメソッドは未サポートです。

●PDFファイル保存情報に関するメソッド

ポイント

PDFファイル保存情報に関するメソッドは、以下の場合のみ有効です。

List Works Print AgentでPDFファイル保存する場合
Web手元印刷型（PDFファイル形式）の場合

public void

setKeepPdf(java.lang.String path)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

出力する帳票（PDF ファイル）のファイル名を以下の範囲で指定します。

帳票配信型の場合

250バイト以内のフルパスまたはファイル名のみで指定します。

Web手元印刷型の場合
- 帳票管理サーバがWindowsの場合
  250バイト以内のフルパスまたはファイル名のみで指定します。
- 帳票管理サーバがSolaris/Linuxの場合
  512バイト以内のフルパスまたはファイル名のみで指定します。

PDFファイル名は、以下の優先順序で有効になります。

このメソッドで指定したPDFファイル名（フルパス）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に、このメソッドで指定したPDFファイル名（ファイル名のみ）で生成
帳票属性の編集コマンド（lmedtformatrコマンド）で指定した「出力ファイル名」（フルパス）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に、帳票属性の編集コマンド（lmedtformatrコマンド）で指定した「出力ファイル名」（ファイル名のみ）で生成
論理デバイスの編集コマンド（lmedtdevコマンド）で指定した「出力フォルダ」に「（配信通番）.pdf」で生成

PDFファイル名は、上記のいずれかで必ず指定してください。

パラメータ

path：: 出力する帳票（PDF ファイル）のファイル名を指定します。

例外

ConnectorException

注意

フォルダ名のみの指定はできません。
同一名ファイルがすでに存在する場合は、アクセス権があれば新しいファイルに置き換えられます。アクセス権がない場合は、PDFファイル保存に失敗します。
同一名ファイルがすでに存在する場合にPDFファイル保存に失敗したときは、元のPDFファイルも削除されることがあります。
PrintPropertiesクラスのsetPropertyメソッドのID_KEEPOWFキーと同時に指定しないでください。ID_KEEPOWFキーが指定されている場合は、ID_KEEPOWFキーで指定した値が有効になります。

備考

指定されたフォルダが存在しない場合、フォルダが自動作成されます。
フォルダには、親フォルダと同じアクセス権が設定されます。アクセス権がない場合は、PrintFormクラスのPrintOutメソッド呼び出し時にエラーになります。
PDFファイルのアクセス権は、以下のように設定されます。
- 帳票配信型の場合
  Administratorsグループにはフルコントロールが付与されます。Usersグループは上位フォルダの権限にしたがいます。
- Web手元印刷型、List Creatorコネクタ連携時の場合
  - 帳票管理サーバがWindowsの場合
    Administratorsグループにはフルコントロールが付与されます。Usersグループは上位フォルダの権限にしたがいます。
  - 帳票管理サーバがSolaris/Linuxの場合
    owner:rootおよびアクセス権は666となります。
PDFファイル名に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”

public void

setPdfSubTitle(java.lang.String subtitle)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルのサブタイトルを指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した概要の「サブタイトル」の指定
設定されない

パラメータ

subtitle：: PDFファイルのサブタイトルを254バイト以内で指定します。

例外

ConnectorException

注意

サブタイトルは、日本語（JIS非漢字/第一水準漢字/第二水準漢字）または英数字で指定してください。その他の文字を指定した場合、PDFファイルの文書情報（一般）で正しく表示されないことがあります。

public void

setPdfAuthor(java.lang.String author)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルの作成者を指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した概要の「作成者」の指定
設定されない

パラメータ

author：: PDFファイルの作成者を254バイト以内で指定します。

例外

ConnectorException

注意

作成者は、日本語（JIS非漢字/第一水準漢字/第二水準漢字）または英数字で指定してください。その他の文字を指定した場合、PDFファイルの文書情報（一般）で正しく表示されないことがあります。

public void

setPdfPrint(boolean print)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルの印刷を許可するかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「印刷の許可」の指定が有効になります。

パラメータ

print：

PDFファイルの印刷を許可するかどうかを指定します。

true：

印刷を許可します。

false：

印刷を許可しません。

例外

ConnectorException

注意

このメソッドを指定する場合は、setPdfSecuPwdメソッドにパスワードを必ず指定してください。パスワードを指定しない場合、PDFファイルのセキュリティの指定が有効にならないことがあります。

public void

setPdfModify(boolean modify)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルの変更を許可するかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「文書変更の許可」の指定が有効になります。

パラメータ

modify：

PDFファイルの変更を許可するかどうかを指定します。

true：: 変更を許可します。

false：: 変更を許可しません。

例外

ConnectorException

注意

PDFファイルの変更を許可する指定をしても、PDFファイルの文書情報（セキュリティ）では「許可しない」となる場合があります。
このメソッドを指定する場合は、setPdfSecuPwdメソッドにパスワードを必ず指定してください。パスワードを指定しない場合、PDFファイルのセキュリティの指定が有効にならないことがあります。

public void

setPdfSelect(boolean select)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルのテキストとグラフィックスの選択を許可するかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「テキストとグラフィックスの選択の許可」の指定が有効になります。

パラメータ

select：

PDFファイルのテキストとグラフィックスの選択を許可するかどうかを指定します。

true：: テキストとグラフィックスの選択を許可します。

false：: テキストとグラフィックスの選択を許可しません。

例外

ConnectorException

注意

このメソッドを指定する場合は、setPdfSecuPwdメソッドにパスワードを必ず指定してください。パスワードを指定しない場合、PDFファイルのセキュリティの指定が有効にならないことがあります。

public void

setPdfAnnotate(boolean annotate)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルの注釈とフォームフィールドの追加と変更を許可するかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定したセキュリティの「注釈とフォームフィールドの追加と変更の許可」の指定が有効になります。

パラメータ

annotate：

PDFファイルの注釈とフォームフィールドの追加と変更を許可するかどうかを指定します。

true：: 注釈とフォームフィールドの追加と変更を許可します。

false：: 注釈とフォームフィールドの追加と変更を許可しません。

例外

ConnectorException

注意

PDFファイルの注釈とフォームフィールドの追加と変更を許可する指定をしても、PDFファイルの文書情報（セキュリティ）では「許可しない」となる場合があります。
このメソッドを指定する場合は、setPdfSecuPwdメソッドにパスワードを必ず指定してください。パスワードを指定しない場合、PDFファイルのセキュリティの指定が有効にならないことがあります。

public void

setPdfPwd(java.lang.String password)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルを開くときのパスワードを指定します。

このメソッドの呼び出しを省略すると、パスワードは設定されません。

パラメータ

password：

PDFファイルを開くときのパスワードを32バイト以内で指定します。

半角文字「"」は指定しないでください。

例外

ConnectorException

注意

パスワードは、半角の英数字または記号（ASCIIコードの文字範囲）で指定してください。その他の文字を指定した場合、PDFファイルを表示できない場合があります。
このメソッドとsetPdfSecuPwdメソッドに同じパスワードを指定しないでください。同じパスワードを指定すると、セキュリティオプションの設定が変更される場合があります。
このメソッドで設定した値は直列化されません。

public void

setPdfSecuPwd(java.lang.String password)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルのセキュリティオプションを変更するときのパスワードを指定します。

このメソッドの呼び出しを省略すると、パスワードは設定されません。

パラメータ

password：

PDFファイルのセキュリティオプションを変更するときのパスワードを32バイト以内で指定します。

半角文字「"」は指定しないでください。

例外

ConnectorException

注意

パスワードは、半角の英数字または記号（ASCIIコードの文字範囲）で指定してください。その他の文字を指定した場合、PDFファイルを表示できない場合があります。
このメソッドとsetPdfPwdメソッドに同じパスワードを指定しないでください。同じパスワードを指定すると、セキュリティオプションの設定が変更される場合があります。
このメソッドで設定した値は直列化されません。

public void

setPdfEmbed(int embed)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルに文字を埋め込むかどうかを指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した文書管理の「文字の埋め込み」の指定が有効になります。

パラメータ

embed：

PDFファイルに文字を埋め込むかどうかを指定します。

PDFEMBED_ALL：: すべての文字をPDFファイルに埋め込みます。

PDFEMBED_NONE：: すべての文字をPDFファイルに埋め込みません。

例外

ConnectorException

注意

利用者定義文字やJEF拡張文字を使用する場合は、文字をPDFファイルに埋め込んでください。PDFファイルに埋め込まない場合、PDFファイルを表示するシステムの環境によっては、見え方が異なる、または正しく表示されないことがあります。

備考

このメソッドでは、埋め込んだ文字の検索を可能にします。
PDFファイルに埋め込んだ文字を検索しない場合は、setPdfEmbed(int embed, boolean
reference)メソッドで、referenceパラメータに「false」を指定してください。

public void

setPdfEmbed(int embed, boolean reference)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルに文字を埋め込むかどうか、およびPDFファイルに埋め込んだ文字を検索できるようにするかどうかを指定します。

referenceパラメータに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、embedパラメータには「PDFEMBED_ALL」、referenceパラメータには「true」が指定されたものとして動作します。

パラメータ

embed：

PDFファイルに文字を埋め込むかどうかを指定します。

PDFEMBED_ALL：: すべての文字をPDFファイルに埋め込みます。

PDFEMBED_NONE：: すべての文字をPDFファイルに埋め込みません。

reference：

PDFファイルに埋め込んだ文字を検索できるようにするかどうかを指定します。

true：: 検索できるようにします。

false：: 検索できるようにしません。

例外

ConnectorException

注意

利用者定義文字やJEF拡張文字を使用する場合は、文字をPDFファイルに埋め込んでください。PDFファイルに埋め込まない場合、PDFファイルを表示するシステムの環境によっては、見え方が異なる、または正しく表示されないことがあります。
PDFファイルに埋め込んだ文字を検索できるようにする場合、以下のいずれかでPDFファイルに文字を埋め込む指定にしておく必要があります。
- List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した文書管理の「文字の埋め込み」の指定
- このメソッドのembed パラメータに「PDFEMBED_ALL」を指定
PDFファイルに埋め込んだ文字を検索できるようにする場合、PDFファイルサイズが大きくなります。

備考

PDFファイルにフォントを埋め込んだ場合、PDFファイルを参照するシステムにフォントがインストールされていなくても参照できます。ただし、埋め込んだ文字列を検索するには、reference パラメータに「true」を指定する必要があります。
embed パラメータに「PDFEMBED_NONE」を指定した場合、referenceパラメータの指定は無効になり、referenceパラメータに「false」が指定されたものとして動作します。

public void

setPdfJpegQuality(int quality)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDF ファイルの JPEG 圧縮時の品質を指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した文書管理の「JPEG圧縮時の品質」の指定が有効になります。

パラメータ

quality：

PDF ファイルの JPEG 圧縮時の品質を指定します。

PDFQUALITY_HIGH：: 高画質、低圧縮率でJPEG圧縮します。

PDFQUALITY_MID：: PDFQUALITY_HIGHとPDFQUALITY_LOWの中間の画質/圧縮率でJPEG圧縮します。

PDFQUALITY_LOW：: 低画質、高圧縮率でJPEG圧縮します。

PDFQUALITY_NONE：: JPEG圧縮されません。画質劣化のないflate圧縮が施されます。

例外

ConnectorException

public void

setPdfEmbedFile(java.lang.String path)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルに添付する任意のファイルのファイル名を指定します。

ファイルは最大で99個まで指定できます。複数指定する場合は、「セミコロン（;）」で区切って指定します。同一ファイルを複数指定すると、エラーとならずに指定したとおり重複して添付されます。

指定されたファイルが存在しない場合は、エラーになります。

このメソッドの呼び出しを省略すると、PDF ファイルにファイルは添付されません。

パラメータ

path：: PDFファイルに添付する任意のファイルのファイル名をフルパスで指定します。

例外

ConnectorException

注意

PDFファイルに添付するファイルは、Acrobat 5.0以降でのみ抽出することができます。
PDFファイルに添付するファイルは、PDFファイル保存時にセキュリティオプションを指定した場合には抽出することができません。詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“A.4 PDF変換機能使用時の注意事項”を参照してください。
このメソッドで指定する「PDFファイルに添付するファイル」がテキストファイルの場合、ファイル中のデータは、必ず以下の文字コード系で記述してください。
- 帳票管理サーバがWindowsの場合
  Shift-JISの文字コード系で記述してください。
- 帳票管理サーバがSolaris/Linuxの場合
  以下のいずれかの文字コード系で記述してください。
  - setFileTypeメソッドで指定した文字コード系
  - 環境変数LANG および環境変数OA_EUCTYPEで指定した文字コード系
  なお、文字コード系の指定は、以下の優先順序で有効になります。
  1. setFileTypeメソッド
  2. 環境変数LANGおよび環境変数OA_EUCTYPE

public void

setPdfAutoPrint(int autoprint)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルの自動印刷、および印刷実行のタイミングを指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイルの自動印刷を行う」の指定が有効になります。

パラメータ

autoprint：

PDFファイルの自動印刷、および印刷実行のタイミングを指定します。

PDFAUTOPRINT_OFF：: 自動印刷しません。

PDFAUTOPRINT_OPN：: PDFファイルを開くと、自動的に印刷ダイアログボックスを表示します。

PDFAUTOPRINT_OPN_CLS：: PDFファイルを開くと、システムで設定されているデフォルトプリンタへ自動的に印刷されます。

例外

ConnectorException

注意

Javaスクリプトが実行不能な場合など、このメソッドを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

public void

setPdfHideToolbar(boolean hidetoolbar)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルを表示する場合、PDFのビューアのツールバーを表示するかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイル表示時のアプリケーションの設定」の「ツールバーを表示する」の指定が有効になります。

パラメータ

hidetoolbar：

PDFファイルを表示する場合、PDFのビューアのツールバーを表示するかどうかを指定します。

true：: PDFファイルを表示する場合、ツールバーを表示しません。

false：: PDFファイルを表示する場合、ツールバーを表示します。

例外

ConnectorException

注意

このメソッドを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

public void

setPdfHideMenubar(boolean hidemenubar)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルを表示する場合、PDFのビューアのメニューバーを表示するかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイル表示時のアプリケーションの設定」の「メニューバーを表示する」の指定が有効になります。

パラメータ

hidemenubar：

PDFファイルを表示する場合、PDFのビューアのメニューバーを表示するかどうかを指定します。

true：: PDFファイルを表示する場合、メニューバーを表示しません。

false：: PDFファイルを表示する場合、メニューバーを表示します。

例外

ConnectorException

注意

このメソッドを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

public void

setPdfFullscreen(boolean fullscreen)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

PDFファイルを表示する場合、PDFのビューアを全画面で表示するかどうかを指定します。

このメソッドに「true」または「false」以外を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［ファイル］タブの文書情報設定画面で指定した動作の「PDFファイル表示時のアプリケーションの設定」の「全画面で表示する」の指定が有効になります。

パラメータ

fullscreen：

PDFファイルを表示する場合、PDFのビューアを全画面で表示するかどうかを指定します。

true：: PDFファイルを表示する場合、PDFのビューアを全画面で表示します。

false：: PDFファイルを表示する場合、PDFのビューアを全画面で表示しません。

例外

ConnectorException

注意

このメソッドを指定しても、PDFのビューアアプリケーションによっては無効となる場合があります。

●印刷属性情報に関するメソッド

ポイント

印刷属性情報に関するメソッドは、以下の場合のみ有効です。

List Works Print Agentで印刷する場合
List Works Workstationで、出力装置にPrint Managerで定義したプリンタを指定した場合

public void

setPrtMode (int mode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の出力開始時の動作モードを指定します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面で指定した出力開始時の動作モードが有効になります。

パラメータ

mode：

帳票の出力開始時の動作モードを指定します。

PRTMODE_OUTPUT：: すぐに帳票を出力します。

PRTMODE_HOLDCL：: すぐに帳票を出力しないで、いったんクライアント側のスプールに保留します。クライアント側とは、List Managerの帳票出力サーバが動作するコンピュータを指します。

例外

ConnectorException

注意

List Managerの帳票出力サーバで帳票の出力を保留するときは、以下のいずれかで出力開始時の動作モードをクライアント側で保留する設定にしておく必要があります。
- List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の出力開始時の動作モード
- setPrtModeメソッド（「PRTMODE_HOLDCL」を指定する）

備考

このメソッドで「PRTMODE_HOLDCL」を指定した場合、以下の方法で保留解除できます。
- List Managerの帳票一覧画面から出力する
- List Managerの帳票ブラウザの出力指示画面から出力する
- 帳票の出力/出力中止コマンド（lmoprprintコマンド）を使用して出力する
- 帳票管理Javaインタフェースを使用して出力する

public void

setJobHResume(java.lang.String time)

throws ConnectorException

用途

このメソッドは未サポートです。

public void

setJobPriority(int priority)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

帳票の出力処理の優先順位を指定します。

数字が大きいほど優先順位は高くなります。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面で指定した出力時の優先順位が有効になります。

パラメータ

priority：: 帳票の出力処理の優先順位を1～99の範囲で指定します。

例外

ConnectorException

public void

setInForm(java.lang.String host)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

このメソッドを指定すると、以下の条件にあてはまる場合に、指定したメッセージ通知先に通知メッセージが通知されます。

帳票の出力中に出力装置にエラーが発生した場合
出力経過の通知メッセージを通知したい場合

このメソッドの呼び出しを省略すると、通知メッセージは通知されません。

パラメータ

host：

以下の場合に通知される通知メッセージの通知先を指定します。

帳票の出力中に出力装置にエラーが発生した場合
出力経過の通知メッセージを通知したい場合

「到着通知パネル」を起動したコンピュータ名（ホスト名）またはIPアドレスを255バイト以内で指定します。

例外

ConnectorException

注意

コンピュータ名（ホスト名）とTCP/IPのホスト名は同一となるようネットワークの設定を行ってください。コンピュータ名（ホスト名）とTCP/IPのホスト名が異なる場合は、IPアドレスで指定してください。
通知メッセージは、このメソッドで指定した「メッセージ通知先（通知メッセージ）」に指定したコンピュータの到着通知パネルに通知されます。したがって、通知メッセージの確認および対処を行う場合、通知先コンピュータであらかじめ「到着通知パネル」を起動しておく必要があります。

備考

以下のいずれかで、帳票の出力状態が「登録」、「失敗」「中止」、「出力済」の帳票を出力する場合、このメソッドで指定したメッセージ通知先（通知メッセージ）を変更することができます。
- 帳票の出力/出力中止コマンド（lmoprprintコマンド）
- 帳票の削除/一覧表示/複写/移動コマンド（lmoprformコマンド）
- 帳票管理Javaインタフェース
メッセージ通知先（通知メッセージ）に指定できる文字については、以下を参照してください。
⇒“8.1 List Manager帳票出力インタフェースで指定できる文字”
通知されるメッセージの詳細については、以下を参照してください。
⇒“B.2 メッセージ通知について”

public void

setJobBanner(boolean banner)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintProperties クラスのsetProperty メソッドで、このメソッ

ドに対応するキーと値による指定を推奨します。

区切りページを出力するかどうかを指定します。

このメソッドは、区切りページを出力しない場合にだけ指定してください。

このメソッドに「false」以外の値を指定した場合、「false」が指定されたものとして動作します。

このメソッドの呼び出しを省略すると、List Creatorデザイナの帳票業務情報のプロパティ画面の［印刷］タブの区切りページ出力設定画面の指定が有効になります。

パラメータ

banner：

区切りページを出力するかどうかを指定します。

false：: 区切りページを出力しません。

例外

ConnectorException

注意

プリンタドライバの設定で RAW データでスプールする設定になっている場合、区切りページは出力されません。

public void

setJobWait(int mode)

throws ConnectorException

用途

このメソッドは未サポートです。

●その他

Javaインタフェースのキーやメソッドでサポートされていない、prprintコマンドのオプションの指定に関するキーについて説明します。

public void

setExecBuffer(java.lang.String param)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

Javaインタフェースのキーやメソッドでサポートされていない、prprintコマンドのオプション（PDF ファイル保存情報（メール配信）に関するオプションなど）を指定します。

パラメータ

param：: Javaインタフェースのキーやメソッドでサポートされていない、prprintコマンドのオプションを指定します。prprintコマンドのオプションについては、以下を参照してください。
⇒“3.3.1 prprintコマンド”

例外

ConnectorException

注意

このメソッドで設定した値は直列化されません。