Class: IMPDFAutoConverter

IMPDFAutoConverter()

PDF変換処理のAPIです。
PDFファイルへ変換するための指示を、PDF変換サーバに出します。

Constructor

new IMPDFAutoConverter()

インスタンスオブジェクトの作成。
Author:
  • 株式会社ワイ・エス・エス
Returns:
生成されたインスタンスオブジェクト
Example
// PDF変換処理のインスタンスを生成します。
var pdfautoconverter = new IMPDFAutoConverter();

Methods

addStamp(stampName)

PDF出力時に追加するスタンプ設定名を指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
Parameters:
Name Type Description
stampName String スタンプ設定名

convert(inFilePath, outFilePath) → {String}

対象ファイルをPDFに変換します。
Parameters:
Name Type Description
inFilePath String 変換対象のファイルパス
outFilePath String 変換後の出力先PDFファイルパス
Throws:
例外発生時スロー
Type
Exception
Returns:
作成したPDFファイルのパス
Type
String

setBeforeTimeoutSec(timeoutSec)

変換前のタイムアウト秒数を設定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
タイムアウト時間は整数で指定してください。
Parameters:
Name Type Description
timeoutSec Number タイムアウト時間（秒）
0：タイムアウトしない（待ち続ける）

setDocInf(title, subTitle, creator, app, keyword)

PDF出力時に設定する文書情報を指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
本メソッドを指定した場合、setDocInfByNameで指定した文書情報は破棄されます。
Parameters:
Name Type Description
title String 文書タイトル
subTitle String 文書サブタイトル
creator String 作成者
app String 作成アプリケーション名
keyword String キーワード

setDocInfAndSecurity(name)

PDF出力時に設定する文書情報とセキュリティを名前で指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
本メソッドを指定した場合、setDocInfで指定した文書情報は破棄されます。
本メソッドを指定した場合、setDocInfByNameで指定した文書情報は破棄されます。
本メソッドを指定した場合、setSecurity40、setSecurity128で指定したセキュリティ設定は破棄されます。
本メソッドを指定した場合、setSecurityByNameで指定したセキュリティ設定は破棄されます。
Parameters:
Name Type Description
name String 文書情報とセキュリティ設定　名称

setDocInfByName(name)

PDF出力時に設定する文書情報を名前で指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
本メソッドを指定した場合、setDocInfで指定した文書情報は破棄されます。
本メソッドを指定した場合、setDocInfAndSecurityで指定した文書情報及びセキュリティ設定は破棄されます。
Parameters:
Name Type Description
name String 文書情報設定の名称

setFastWebView(fastWebView)

WEB用に最適化する/しないを指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
Parameters:
Name Type Description
fastWebView boolean 最適化する場合は true、それ以外は false

setFolderName(name, overwrite)

フォルダ名及びフォルダ別設定の情報を設定します。
本メソッドを指定した場合、その他のメソッドで指定した全ての設定は破棄されます。
Parameters:
Name Type Description
name String フォルダ名
overwrite boolean フォルダ別設定を上書き設定する場合は true、それ以外は false

setPrinter(name)

PDF出力時に使用するプリンタの名前を指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
Parameters:
Name Type Description
name String プリンタ名

setSecurity40(openPassword, securityPassword, noPrint, noEdit, noCopy, noAddNote)

PDF出力時に設定する40ビットセキュリティ情報を指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
本メソッドを指定した場合、setSecurityByNameで指定したセキュリティ設定は破棄されます。
本メソッドを指定した場合、setDocInfAndSecurityで指定した文書情報及びセキュリティ設定は破棄されます。
Parameters:
Name Type Description
openPassword String オープンパスワード
securityPassword String セキュリティパスワード
noPrint boolean 印刷を許可しない場合は true、それ以外は false
noEdit boolean アクセス（編集）を許可しない場合は true、それ以外は false
noCopy boolean コピーを許可しない場合は true、それ以外は false
noAddNote boolean 文書変更（注釈追記）を許可しない場合は true、それ以外は false

setSecurity128(openPassword, securityPassword, print, acc, copy, change)

PDF出力時に設定する128ビットセキュリティ情報を指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
本メソッドを指定した場合、setSecurityByNameで指定したセキュリティ設定は破棄されます。
本メソッドを指定した場合、setDocInfAndSecurityで指定した文書情報及びセキュリティ設定は破棄されます。
Parameters:
Name Type Description
openPassword String オープンパスワード
securityPassword String セキュリティパスワード
print String 印刷セキュリティを表す文字列
"PRINT_DISABLE"：許可しない
"PRINT_DEGRADED"：低解像度で許可する
"PRINT_ENABLE"：許可する
acc String アクセス（編集）セキュリティを表す文字列
"ACC_DISABLE"：許可しない
"ACC_ENABLE"：許可する
copy String コピーセキュリティを表す文字列
"COPY_DISABLE"：許可しない
"COPY_ENABLE"：許可する
change String 文書変更（注釈追記）セキュリティを表す文字列
"DOCCHANGE_DISABLE"：許可しない
"DOCCHANGE_ASSEMBLE"：アセンブリを許可する
"DOCCHANGE_FORMFILL"：フォーム入力を許可する
"DOCCHANGE_ADDNOTE"：フォーム入力と注釈追加を許可する
"DOCCHANGE_ENABLE"：許可する
Example
// 128ビットセキュリティ情報を指定します。
// @param {String} openPassword オープンパスワード
// @param {String} securityPassword セキュリティパスワード
// @param {String} print 印刷セキュリティを表す文字列　⇒　"PRINT_ENABLE"（許可する）
// @param {String} acc アクセス（編集）セキュリティを表す文字列　⇒　"ACC_DISABLE"（許可しない）
// @param {String} copy コピーセキュリティを表す文字列　⇒　"COPY_ENABLE"（許可する）
// @param {String} change 文書変更（注釈追記）セキュリティを表す文字列　⇒　"DOCCHANGE_ADDNOTE"（フォーム入力と注釈追加を許可する）
pdfautoconverter.setSecurity128("open", "sec", "PRINT_ENABLE", "ACC_DISABLE", "COPY_ENABLE", "DOCCHANGE_ADDNOTE");

setSecurityByName(name)

PDF出力時に設定するセキュリティ設定を名前で指定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
本メソッドを指定した場合、setSecurity40、setSecurity128で指定したセキュリティ設定は破棄されます。
本メソッドを指定した場合、setDocInfAndSecurityで指定した文書情報及びセキュリティ設定は破棄されます。
Parameters:
Name Type Description
name String セキュリティ設定の名称

setTimeoutSec(timeoutSec)

変換後のタイムアウト秒数を設定します。
本メソッドを指定した場合、setFolderNameで指定したフォルダ別設定は破棄されます。
タイムアウト時間は整数で指定してください。
Parameters:
Name Type Description
timeoutSec Number タイムアウト時間（秒）
0：タイムアウトしない（待ち続ける）

setTransTimeoutMilliSec(timeoutMilliSec)

PDF変換サーバへのファイル転送のタイムアウトミリ秒を設定します。
タイムアウト時間は整数で指定してください。
Parameters:
Name Type Description
timeoutMilliSec Number タイムアウト時間（ミリ秒）