new IODBDoc(ddl)
IODBDOCレイアウトファイル(DDL)とオブジェクトデータから IOD又はPDF形式ファイルを生成するAPIです。
各定義ファイルおよびデータファイルは Public Storage に保存しておく必要があります。
実行後に作成されるIOD/PDFファイルは、Public Storageに作られます。
各定義ファイルおよびデータファイルは Public Storage に保存しておく必要があります。
実行後に作成されるIOD/PDFファイルは、Public Storageに作られます。
Parameters:
Name | Type | Description |
---|---|---|
ddl |
String | 入力DDLレイアウトファイル(Pubilc Storageからの相対形式で表されるパス名[英数字]) |
Throws:
-
例外発生時スロー
- Type
- Exception
Methods
changeddl(ddl, changePage, initCalcVal, initGlobalVal)
DDLレイアウトファイルを切り替えます。
Parameters:
Name | Type | Description |
---|---|---|
ddl |
String | DDLレイアウトファイル(Pubilc Storageからの相対形式で表されるパス名[英数字]) |
changePage |
boolean | DDL切り替え時に改ページする場合は true、改ページしない場合は false |
initCalcVal |
boolean | DDL切り替え時に演算値を初期化する場合は true、初期化しない場合は false |
initGlobalVal |
boolean | DDL切り替え時に外部変数の値を初期化する場合は true、初期化しない場合は false |
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 | 文字エンコード形式 |
setCol(value)
データ行にカラムを追加します。
DDLレイアウトファイルで定義したカラムと同数のデータが設定されるように指定してください。
nullは指定しないでください。
DDLレイアウトファイルで定義したカラムと同数のデータが設定されるように指定してください。
nullは指定しないでください。
Parameters:
Name | Type | Description |
---|---|---|
value |
String | 追加する値(画像ファイルのパスを指定する場合、絶対形式で表されるパス名[英数字]) |
setColEnd()
データ行の設定を終了します。
setColStart()
データ行の設定を開始します。
setGlobal(name, value)
外部変数値を設定します。
Parameters:
Name | Type | Description |
---|---|---|
name |
String | 識別子名 |
value |
String | 値(画像ファイルのパスを指定する場合、絶対形式で表されるパス名[英数字]) |
setOpenPassword(openpass)
PDFオープンパスワードを設定します。
Parameters:
Name | Type | Description |
---|---|---|
openpass |
String | オープンパスワード |
setSecurityPassword(secpass)
PDFセキュリティパスワードを設定します。
Parameters:
Name | Type | Description |
---|---|---|
secpass |
String | セキュリティパスワード |
toIOD(path) → {Number}
IODファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name | Type | Description |
---|---|---|
path |
String | 出力IODファイル(Public Storageからの相対形式で表されるパス名[英数字]) |
Returns:
IODファイルの出力に成功した場合は0以上、失敗した場合は-1以下
- Type
- Number
toPDF(path) → {Number}
PDFファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name | Type | Description |
---|---|---|
path |
String | 出力PDFファイル(Public Storageからの相対形式で表されるパス名[英数字]) |
Returns:
PDFファイルの出力に成功した場合は0以上、失敗した場合は-1以下
- Type
- Number