Class: IODBDocRemote

IODBDocRemote(ddl)

new IODBDocRemote(ddl)

IODBDOCレイアウトファイルとオブジェクトデータから IOD又はPDF形式ファイルを生成するAPIです。
各定義ファイルおよびデータファイルは Public Storage に保存しておく必要があります。
実行後に作成されるIOD/PDFファイルは、Public Storageに作られます。
Parameters:
Name Type Description
ddl String 入力DDLレイアウトファイル
Author:
  • 株式会社ワイ・エス・エス

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 編集許可フラグ文字列(MODIFY_FORM_AND_ANNOTATION/MODIFY_FORM_AND_ASSEMBLY /MODIFY_ALL/MODIFY_DISABLE)

printSecurity(flgname)

PDFセキュリティの印刷許可フラグを設定します。
Parameters:
Name Type Description
flgname String 印刷許可フラグ文字列(PRINT_ENABLE/PRINT_DISABLE)

setCharset(charset)

内部生成ファイル文字エンコード形式セットです。
内部で作成されるオブジェクトデータ形式によるDATデータファイルの文字列エンコード形式を設定します。
指定されない場合はデフォルトのMS932形式でファイルが作成されます。
Parameters:
Name Type Description
charset String 文字エンコード形式

setCol(value)

データ行にカラムを追加します。
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()により取得できる返却メッセージにより確認してください。
Parameters:
Name Type Description
path String 出力IODファイル(Public Storageからの相対形式で表されるパス名[英数字])
Returns:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
Type
Number

toPDF(path) → {Number}

PDFファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name Type Description
path String 出力PDFファイル(Public Storageからの相対形式で表されるパス名[英数字])
Returns:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
Type
Number