Class: pdfcombine

pdfcombine()

PDFをファイル単位で結合するクラスです。

Constructor

new pdfcombine()

インスタンスオブジェクトの作成。
Author:
  • 株式会社ワイ・エス・エス
Returns:
生成されたインスタンスオブジェクト
Example
// PDFをファイル単位で結合するクラスのインスタンスを生成します。
var combine = new pdfcombine();

Extends

Members

m_encode

Properties:
Name Type Description
m_encode String getBytes()などで使用するエンコード文字列です。
文字列を取り扱うメソッドを使用する際は、事前に当メンバへ"MS932"を指定してください。
指定しなかった場合、全角文字にて文字化けが発生し、正常に処理されない可能性があります。
Overrides:
Example
// @property {String} m_encode getBytesなどで使用するエンコード文字列です。
comb.m_encode = "MS932";

Methods

bytetostr(bstr) → {String}

バイナリのNumber[]をStringに変換して返します。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
Parameters:
Name Type Description
bstr Array.<Number> 変換を行う配列
Inherited From:
Returns:
bstrがヌルの場合は、ヌルを返します。
m_encodeが、ヌルの場合はnew String(bstr)を返します。
m_encodeが、ヌルでない場合はnew String(str,m_encode)を 返します。
Type
String
Example
// バイナリのNumber[]をStringに変換して返します。
// 使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
// @param {Number[]} bstr 変換を行う配列
makeup.m_encode = "MS932";
var convertedString = makeup.bytetostr(binaryArray);

close() → {Number}

出力PDFを連結及びクローズし、連結を終了します。
Returns:
Type
Number

combine(pdf) → {Number}

指定ファイルのPDF連結の準備をします。
Parameters:
Name Type Description
pdf String 連結するPDFのファイル名を指定します。
Returns:
Type
Number

combinewithpassword(pdf, passwd) → {Number}

指定ファイル(パスワード付き)のPDF連結の準備をします。
Parameters:
Name Type Description
pdf String 連結するPDFのファイル名を指定します。
passwd String 連結するPDFのセキュリティパスワードを指定します。
Returns:
Type
Number

geterror() → {String}

最後のエラーの要因メッセージを返します。
Overrides:
Returns:
エラーの要因メッセージ
Type
String

geterrorno() → {Number}

最後のエラー要因(数値)を返します。
Overrides:
Returns:
エラー要因(数値)
Type
Number

getversion() → {String}

バージョン(文字列)を返します。
Inherited From:
Returns:
バージョン(文字列)
Type
String

getversionno() → {Number}

バージョン(数値)を返します。
Inherited From:
Returns:
バージョン(数値)
Type
Number

init() → {Number}

内部メンバの初期化等を行います。
Returns:
正常時は0、エラー時は-1を返します。
Type
Number

initwithetcpath(etcpath) → {Number}

内部メンバの初期化等を行います。環境ファイルパスを指定できます。
Parameters:
Name Type Description
etcpath String 環境ファイルパス
Returns:
正常時は0、エラー時は-1を返します。
Type
Number

open(outpdf) → {Number}

出力PDFをオープンし、連結の準備をします。
Parameters:
Name Type Description
outpdf String 出力先PDFのファイル名を指定します。
Returns:
Type
Number

release()

内部のハンドルを開放します。

setdocinfo(title, subtitle, creator, app, keyword) → {Number}

出力PDFの文書情報を設定します。
Parameters:
Name Type Description
title String タイトルに設定する文字列を指定します。
subtitle String サブタイトルに設定する文字列を指定します。
creator String 作成者に設定する文字列を指定します。
app String 作成アプリケーションに設定する文字列を指定します。
keyword String キーワードに設定する文字列を指定します。
Returns:
Type
Number
Example
// 出力PDFの文書情報を設定します。
// @param {String} title タイトルに設定する文字列を指定します。
// @param {String} subtitle サブタイトルに設定する文字列を指定します。
// @param {String} creator 作成者に設定する文字列を指定します。
// @param {String} app 作成アプリケーションに設定する文字列を指定します。
// @param {String} keyword キーワードに設定する文字列を指定します。
comb.setdocinfo("タイトル", "サブタイトル", "作成者", "アプリケーション", "キーワード");

setfastwebview(bfastwebview) → {Number}

PDF出力後のWebに最適化の処理の有無を設定します。
特にこのメソッドを呼び出さない場合はデフォルトで最適化されます。
Parameters:
Name Type Description
bfastwebview boolean true:最適化する,false:最適化しない
Returns:
Type
Number

setoptionvalue(optiontype, optionvalue) → {Number}

各種オプションを設定します。
Parameters:
Name Type Description
optiontype String オプションの種類を表す文字列
"PORTFOLIOERROR":ポートフォリオファイルをエラーにする
"XFAFORMERROR":XFA Formファイルをエラーにする
"PAGETREEVALIDATE":ページツリーの整合性をチェックする
optionvalue Number
Inherited From:
Returns:
Type
Number
Example
// 各種オプションを設定します。
// @param {String} optiontype オプションの種類を表す文字列 ⇒ "PORTFOLIOERROR":ポートフォリオファイルをエラーにする
// @param {Number} optionvalue
makeup.setoptionvalue("PORTFOLIOERROR", 1);

setpdfamode(bpdfamode, reserved) → {Number}

Parameters:
Name Type Description
bpdfamode boolean
reserved Number
Overrides:
Returns:
Type
Number

setsecurity(fromtop, showpasswd, securitypasswd, noprint, noedit, nocopy, noaddnote) → {Number}

出力PDFのRC4 40ビットセキュリティを設定します。
Parameters:
Name Type Description
fromtop boolean 連結元の先頭のPDFを引継ぎます。
showpasswd String 参照用のパスワードを指定します。
securitypasswd String セキュリティ設定用のパスワードを指定します。
noprint boolean 印刷(true:不可,false:可能)
noedit boolean 編集(true:不可,false:可能)
nocopy boolean 転載(true:不可,false:可能)
noaddnote boolean 注釈追加(true:不可,false:可能)
Returns:
Type
Number

setsecurity128(showpasswd, securitypasswd, print, access, copy, change) → {Number}

出力PDFのRC4 128ビットセキュリティを設定します。
Parameters:
Name Type Description
showpasswd String 参照用のパスワードを指定します。
securitypasswd String セキュリティ設定用のパスワードを指定します。
print String 128bit security(印刷)を指定します。
"PRINT_DISABLE":許可しない
"PRINT_DEGRADED":低解像度で許可する
"PRINT_ENABLE":許可する
access String 128bit security(アクセス)を指定します。
"ACC_DISABLE":許可しない
"ACC_ENABLE":許可する
copy String 128bit security(転載)を指定します。
"COPY_DISABLE":許可しない
"COPY_ENABLE":許可する
change String 128bit security(文書変更)を指定します。
"DOCCHANGE_DISABLE":許可しない
"DOCCHANGE_ASSEMBLE":アセンブリを許可する
"DOCCHANGE_FORMFILL":フォーム入力を許可する
"DOCCHANGE_ADDNOTE":フォーム入力と注釈追加を許可する
"DOCCHANGE_ENABLE":許可する
Returns:
Type
Number
Example
// 出力PDFのRC4 128ビットセキュリティを設定します。
// @param {String} showpasswd 参照用のパスワードを指定します。
// @param {String} securitypasswd セキュリティ設定用のパスワードを指定します。
// @param {String} print 128bit security(印刷)を指定します。 ⇒ "PRINT_DEGRADED":低解像度で許可する
// @param {String} access 128bit security(アクセス)を指定します。 ⇒ "ACC_ENABLE":許可する
// @param {String} copy 128bit security(転載)を指定します。 ⇒ "COPY_DISABLE":許可しない
// @param {String} change 128bit security(文書変更)を指定します。 ⇒ "DOCCHANGE_ADDNOTE":フォーム入力と注釈追加を許可する
combine.setsecurity128("show", "sec", "PRINT_DEGRADED", "ACC_ENABLE", "COPY_DISABLE", "DOCCHANGE_ADDNOTE");

setsecurityaes128(showpasswd, securitypasswd, print, access, copy, change) → {Number}

出力PDFのAES 128ビットセキュリティを設定します。
Parameters:
Name Type Description
showpasswd String 参照用のパスワードを指定します。
securitypasswd String セキュリティ設定用のパスワードを指定します。
print String 128bit security(印刷)を指定します。
"PRINT_DISABLE":許可しない
"PRINT_DEGRADED":低解像度で許可する
"PRINT_ENABLE":許可する
access String 128bit security(アクセス)を指定します。
"ACC_DISABLE":許可しない
"ACC_ENABLE":許可する
copy String 128bit security(転載)を指定します。
"COPY_DISABLE":許可しない
"COPY_ENABLE":許可する
change String 128bit security(文書変更)を指定します。
"DOCCHANGE_DISABLE":許可しない
"DOCCHANGE_ASSEMBLE":アセンブリを許可する
"DOCCHANGE_FORMFILL":フォーム入力を許可する
"DOCCHANGE_ADDNOTE":フォーム入力と注釈追加を許可する
"DOCCHANGE_ENABLE":許可する
Returns:
Type
Number
Example
// 出力PDFのAES 128ビットセキュリティを設定します。
// @param {String} showpasswd 参照用のパスワードを指定します。
// @param {String} securitypasswd セキュリティ設定用のパスワードを指定します。
// @param {String} print 128bit security(印刷)を指定します。 ⇒ "PRINT_DEGRADED":低解像度で許可する
// @param {String} access 128bit security(アクセス)を指定します。 ⇒ "ACC_ENABLE":許可する
// @param {String} copy 128bit security(転載)を指定します。 ⇒ "COPY_DISABLE":許可しない
// @param {String} change 128bit security(文書変更)を指定します。 ⇒ "DOCCHANGE_ADDNOTE":フォーム入力と注釈追加を許可する
combine.setsecurityaes128("show", "sec", "PRINT_DEGRADED", "ACC_ENABLE", "COPY_DISABLE", "DOCCHANGE_ADDNOTE");

settemppath(temppath) → {Number}

処理中で使用する、一時ファイルの作成先を指定します。
Parameters:
Name Type Description
temppath String 一時ファイルの作成先
Returns:
正常時:0, エラー時:負の値
Type
Number

strtobyte(bstr) → {Array.<Number>}

StringをバイナリとしてNumber[]に変換して返します。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
Parameters:
Name Type Description
bstr String 変換を行う文字列
Inherited From:
Returns:
strがヌルの場合は、ヌルを返します。
m_encodeが、ヌルの場合はstr.getBytes()を返します。
m_encodeが、ヌルでない場合はstr.getBytes(m_encode)を 返します。
Type
Array.<Number>
Example
// StringをバイナリとしてNumber[]に変換して返します。
// 使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
// @param {String} bstr 変換を行う文字列
makeup.m_encode = "MS932";
var binaryString = strtobyte("sample");