new IODoc(iod, cdd)
単票用レイアウトファイルと、CSV形式のデータファイル又はDAT形式のデータファイル又はオブジェクトデータからIOD又はPDF形式ファイルを生成するAPIです。
各定義ファイルおよびデータファイルは Public Storage に保存しておく必要があります。
実行後に作成されるIOD/PDFファイルは、Public Storageに作られます。
各定義ファイルおよびデータファイルは Public Storage に保存しておく必要があります。
実行後に作成されるIOD/PDFファイルは、Public Storageに作られます。
Parameters:
Name | Type | Description |
---|---|---|
iod |
String | 入力IODレイアウトファイル(Pubilc Storageからの相対形式で表されるパス名[英数字]) |
cdd |
String | CDDデータファイル(CSVデータ使用時必須。Pubilc Storageからの相対形式で表されるパス名[英数字]) |
Throws:
-
例外発生時スロー
- Type
- Exception
Methods
copySecurity(flgname)
PDFセキュリティのテキスト抽出コピー許可フラグを設定します。
Parameters:
Name | Type | Description |
---|---|---|
flgname |
String | テキスト抽出コピー許可フラグ文字列(COPY_AND_ACCESSBILITY_ENABLE/COPY_AND_ACCESSBILITY_DISABLE) |
createTempFile() → {String}
アプリケーションサーバの管理するテンポラリディレクトリ上にテンポラリファイルを作成し、その絶対パス名を返却します。
Returns:
テンポラリファイルの絶対パス
- Type
- String
defineApplication(appliname)
PDF文書情報作成アプリケーション名を設定します。
Parameters:
Name | Type | Description |
---|---|---|
appliname |
String | 作成アプリケーション名 |
defineAuthor(author)
PDF文書情報作成者を設定します。
Parameters:
Name | Type | Description |
---|---|---|
author |
String | 作成者 |
defineSubTitle(subtitle)
PDF文書情報サブタイトルを設定します。
Parameters:
Name | Type | Description |
---|---|---|
subtitle |
String | 文書サブタイトル |
defineTitle(title)
PDF文書情報タイトルを設定します。
Parameters:
Name | Type | Description |
---|---|---|
title |
String | 文書タイトル |
getMessage() → {String}
実行結果メッセージを取得します。
Returns:
結果メッセージ文字列
- Type
- String
modifySecurity(flgname)
PDFセキュリティの編集許可フラグを設定します。
Parameters:
Name | Type | Description |
---|---|---|
flgname |
String |
printSecurity(flgname)
PDFセキュリティの印刷許可フラグを設定します。
Parameters:
Name | Type | Description |
---|---|---|
flgname |
String | 印刷許可フラグ文字列(PRINT_ENABLE/PRINT_DISABLE) |
setCharset(charset)
内部生成ファイル文字エンコード形式セットです。
内部で作成されるオブジェクトデータ形式によるDATデータファイルの文字列エンコード形式を設定します。
指定されない場合はデフォルトのMS932形式でファイルが作成されます。
内部で作成されるオブジェクトデータ形式によるDATデータファイルの文字列エンコード形式を設定します。
指定されない場合はデフォルトのMS932形式でファイルが作成されます。
Parameters:
Name | Type | Description |
---|---|---|
charset |
String | 文字エンコード形式 |
setCSV(path)
CSV形式データファイル・パスを設定します。
CSV形式データファイルを使用する場合は、CDDファイルとセットで使用します。
また、DAT形式ファイル、オブジェクト直接指定方式との同時使用はできません。
CSV形式データファイル内で画像ファイルのパスを指定する場合は、絶対形式で表されるパス名[英数字]を指定してください。
CSV形式データファイルを使用する場合は、CDDファイルとセットで使用します。
また、DAT形式ファイル、オブジェクト直接指定方式との同時使用はできません。
CSV形式データファイル内で画像ファイルのパスを指定する場合は、絶対形式で表されるパス名[英数字]を指定してください。
Parameters:
Name | Type | Description |
---|---|---|
path |
String | CSV形式データファイルパス(Public Storageからの相対形式で表されるパス名[英数字]) |
setDAT(path)
DAT形式データファイル・パスを設定します。
CSV形式ファイル、オブジェクト直接指定方式との同時使用はできません。
DAT形式データファイル内で画像ファイルのパスを指定する場合は、絶対形式で表されるパス名[英数字]を指定してください。
CSV形式ファイル、オブジェクト直接指定方式との同時使用はできません。
DAT形式データファイル内で画像ファイルのパスを指定する場合は、絶対形式で表されるパス名[英数字]を指定してください。
Parameters:
Name | Type | Description |
---|---|---|
path |
String | DAT形式データファイルパス(Public Storageからの相対形式で表されるパス名[英数字]) |
setData(id, data)
IODoc出力用オブジェクトデータをセットします。
Parameters:
Name | Type | Description |
---|---|---|
id |
String | 埋め込みオブジェクトID |
data |
String | 埋め込みオブジェクトデータ文字列(画像ファイルのパスを指定する場合、絶対形式で表されるパス名[英数字]) |
setImageData(id, filepath)
IODoc出力用オブジェクトデータ(イメージ)をセットします。
Parameters:
Name | Type | Description |
---|---|---|
id |
String | 埋め込みオブジェクトID |
filepath |
String | 埋め込みイメージファイル(Public Storageからの相対形式で表されるパス名[英数字]) |
setOpenPassword(openpass)
PDFオープンパスワードを設定します。
Parameters:
Name | Type | Description |
---|---|---|
openpass |
String | オープンパスワード |
setOutPage()
IODocでのページ切り替え指定をセットします。
setSecurityPassword(secpass)
PDFセキュリティパスワードを設定します。
Parameters:
Name | Type | Description |
---|---|---|
secpass |
String | セキュリティパスワード |
setTextBoxData(textboxdata)
IODoc出力用オブジェクトデータ(文字枠用)のデータをセットします。
テキストデータの1行分のデータレコードをセットします。複数行の場合は連続して当メソッドを呼び出します。
テキストデータの1行分のデータレコードをセットします。複数行の場合は連続して当メソッドを呼び出します。
Parameters:
Name | Type | Description |
---|---|---|
textboxdata |
String | 埋め込みデータ文字列 |
setTextBoxEnd()
IODoc出力用オブジェクトデータ(文字枠用)の終了宣言です。
文字枠挿入データ文字列を全てセット後、必ず呼び出します。
文字枠挿入データ文字列を全てセット後、必ず呼び出します。
setTextBoxStart(id)
IODoc出力用オブジェクトデータ(文字枠用)の開始宣言です。
Parameters:
Name | Type | Description |
---|---|---|
id |
String | 埋め込みオブジェクトID(文字枠) |
toIOD(path) → {Number}
IODファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name | Type | Description |
---|---|---|
path |
String | 出力IODファイル(Public Storageからの相対形式で表されるパス名[英数字]) |
Returns:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
- Type
- Number
toPDF(path) → {Number}
PDFファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name | Type | Description |
---|---|---|
path |
String | 出力PDFファイル(Public Storageからの相対形式で表されるパス名[英数字]) |
Returns:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
- Type
- Number