Constructor
new pmuedit()
インスタンスオブジェクトの作成。
Returns:
生成されたインスタンスオブジェクト
Example
// PDFページ配置クラスのインスタンスを生成します。
var edit = new pmuedit();
Extends
Members
m_encode
Properties:
Name | Type | Description |
---|---|---|
m_encode |
String | getBytes()などで使用するエンコード文字列です。 文字列を取り扱うメソッドを使用する際は、事前に当メンバへ"MS932"を指定してください。 指定しなかった場合、全角文字にて文字化けが発生し、正常に処理されない可能性があります。 |
- Overrides:
Example
// @property {String} m_encode getBytesなどで使用するエンコード文字列です。
edit.m_encode = "MS932";
Methods
addobjoutputpdf(filename) → {Number}
追記オブジェクトを指定されたファイルにPDF出力します。
またこの関数は内部で連結処理を行いません。
対象のソースファイルが複数指定された場合は、最初のソースのみを処理します。
またこの関数は内部で連結処理を行いません。
対象のソースファイルが複数指定された場合は、最初のソースのみを処理します。
Parameters:
Name | Type | Description |
---|---|---|
filename |
String | 出力先のPDFファイルのファイル名 |
- Inherited From:
Returns:
- Type
- Number
addpage(src, page) → {Number}
指定された切出し元のPDFの指定ページを出力時の対象とします。
Parameters:
Name | Type | Description |
---|---|---|
src |
pmusrc | 切出し元のPDF |
page |
Number | 切出し元のPDF内のページ |
- Inherited From:
Returns:
- Type
- Number
addpagerotate(src, page, rotate) → {Number}
指定された切出し元のPDFの指定ページを、回転角度付きで出力時の対象とします。
Parameters:
Name | Type | Description |
---|---|---|
src |
pmusrc | 切出し元のPDF |
page |
Number | 切出し元のPDF内のページ |
rotate |
Number | 角度 |
- Inherited From:
Returns:
- Type
- Number
addsrcfile(filename, passwd) → {Number}
指定された切出し元のPDFの全てのページを出力時の対象とします。
Parameters:
Name | Type | Description |
---|---|---|
filename |
String | 切出し元のPDFのファイル名 |
passwd |
String | 切出し元のPDFのパスワード |
- Inherited From:
Returns:
切出し元のPDFファイルのページ数を返します。
- Type
- Number
addsrcfilefast(filename, passwd, busetmp) → {Number}
指定された切出し元のPDFの全てのページを出力時の対象とします。
Parameters:
Name | Type | Description |
---|---|---|
filename |
String | 切出し元のPDFのファイル名 |
passwd |
String | 切出し元のPDFのパスワード |
busetmp |
boolean | 指定ファイルを一時ファイルにコピーして処理する |
- Inherited From:
Returns:
- Type
- Number
bytetostr(bstr) → {String}
バイナリのNumber[]をStringに変換して返します。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"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)を 返します。
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);
cleanpdf(filename, passwd, dst) → {Number}
不要な情報をチェックしクリーンします。
予めsetcleanflags()で、処理内容を指定して下さい。
予めsetcleanflags()で、処理内容を指定して下さい。
Parameters:
Name | Type | Description |
---|---|---|
filename |
String | 編集元のファイル名 |
passwd |
String | 編集元のパスワード |
dst |
String | 出力先のファイル名 |
- Inherited From:
- See:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
closeoutput() → {Number}
ページ配置用にオープンされている出力ファイルをクローズします。
また、outpage()呼び出しが、基本PDFの途中のページで打ち切られた場合は、残りのページも出力してからクローズします。
また、outpage()呼び出しが、基本PDFの途中のページで打ち切られた場合は、残りのページも出力してからクローズします。
- See:
Returns:
- Type
- Number
createjavascript(page) → {pmujavascript}
Javascriptオブジェクトを作成します。
Parameters:
Name | Type | Description |
---|---|---|
page |
String | Number | Javascriptの挿入タイプを指定します。 "DOCUMENT"もしくは0:ドキュメントに対してJavascriptを挿入 "COMMON":汎用JavaScriptを挿入 1以上の数字:Javascriptを挿入する出力PDF上のページ番号 |
- Inherited From:
Returns:
正常時:pmujavascriptのインスタンス, エラー時:null
- Type
- pmujavascript
Examples
// Javascriptオブジェクトを作成します。
// @param {String} page Javascriptの挿入タイプを指定します。 ⇒ "DOCUMENT"もしくは0:ドキュメントに対してJavascriptを挿入
var pjavascript = dst.createjavascript("DOCUMENT");
// Javascriptオブジェクトを作成します。
// @param {Number} page Javascriptの挿入タイプを指定します。 ⇒ 1以上の数字:Javascriptを挿入する出力PDF上のページ番号
var pjavascript = dst.createjavascript(1);
// Javascriptオブジェクトを作成します。
// @param {String} page Javascriptの挿入タイプを指定します。 ⇒ 1以上の数字:Javascriptを挿入する出力PDF上のページ番号
// ページ番号は文字での指定も可能です。
var pjavascript = dst.createjavascript("3");
createlayer() → {pmuobjlayer}
ページ配置インスタンス内にレイヤを作成します。
Returns:
作成したレイヤ
- Type
- pmuobjlayer
createobj(objtype) → {pmuobjformbutton|pmuobjformtext|pmuobjnotebox|pmuobjnotefreetext|pmuobjnotehighlight|pmuobjnotepolygon|pmuobjimage|pmuobjiod|pmuobjlink|pmuobjpage|pmuobjtext|pmuobjtrans|pmuobjwatermark}
PDF出力時に追記するオブジェクトクラスを作成します。
Parameters:
Name | Type | Description |
---|---|---|
objtype |
String | 以下のオブジェクトの種類を指定します。 "FORMBUTTON":BUTTONフォームオブジェクト "FORMTEXT":TEXTフォームオブジェクト "NOTEBOX":BOX型注釈オブジェクト "NOTEFREETEXT":FREETEXT型注釈オブジェクト "NOTEHIGHLIGHT":HIGHLIGHT型注釈オブジェクト "NOTEPOLYGON":POLYGON型注釈オブジェクト "IMAGE":イメージ "IOD":IODファイル "LINK":ハイパーリンク "PAGE":旧バージョン互換用ページ番号 "PAGENUMBER":ページ番号 "TEXT":テキスト枠 "TRANS":透過オブジェクト "WATERMARK":ウォーターマーク |
- Inherited From:
Returns:
PDF出力時に追記するオブジェクトクラス
引数objtypeに応じて、以下のクラスを返します。
"FORMBUTTON":pmuobjformbutton
"FORMTEXT":pmuobjformtext
"NOTEBOX":pmuobjnotebox
"NOTEFREETEXT":pmuobjnotefreetext
"NOTEHIGHLIGHT":pmuobjnotehighlight
"NOTEPOLYGON":pmuobjnotepolygon
"IMAGE":pmuobjimage
"IOD":pmuobjiod
"LINK":pmuobjlink
"PAGE":pmuobjpage
"PAGENUMBER":pmuobjpage
"TEXT":pmuobjtext
"TRANS":pmuobjtrans
"WATERMARK":pmuobjwatermark
引数objtypeに応じて、以下のクラスを返します。
"FORMBUTTON":pmuobjformbutton
"FORMTEXT":pmuobjformtext
"NOTEBOX":pmuobjnotebox
"NOTEFREETEXT":pmuobjnotefreetext
"NOTEHIGHLIGHT":pmuobjnotehighlight
"NOTEPOLYGON":pmuobjnotepolygon
"IMAGE":pmuobjimage
"IOD":pmuobjiod
"LINK":pmuobjlink
"PAGE":pmuobjpage
"PAGENUMBER":pmuobjpage
"TEXT":pmuobjtext
"TRANS":pmuobjtrans
"WATERMARK":pmuobjwatermark
- Type
- pmuobjformbutton | pmuobjformtext | pmuobjnotebox | pmuobjnotefreetext | pmuobjnotehighlight | pmuobjnotepolygon | pmuobjimage | pmuobjiod | pmuobjlink | pmuobjpage | pmuobjtext | pmuobjtrans | pmuobjwatermark
Example
// PDF出力時に追記するオブジェクトクラスを作成します。
// @param {String} objtype オブジェクトの種類を指定します。 ⇒ "TEXT":テキスト枠
var pobj = dst.createobj("TEXT");
createobjformbutton() → {pmuobjformbutton}
ボタンフォームクラスを作成します。
- Inherited From:
Returns:
ボタンフォームクラス
- Type
- pmuobjformbutton
createobjformtext() → {pmuobjformtext}
テキストフォームクラスを作成します。
- Inherited From:
Returns:
テキストフォームクラス
- Type
- pmuobjformtext
createobjimage() → {pmuobjimage}
PDF出力時に追記するイメージオブジェクトクラスを作成します。
- Inherited From:
Returns:
イメージオブジェクトクラス
- Type
- pmuobjimage
createobjiod() → {pmuobjiod}
PDF出力時に追記するIODオブジェクトクラスを作成します。
- Inherited From:
Returns:
IODオブジェクトクラス
- Type
- pmuobjiod
createobjlink() → {pmuobjlink}
ハイパーリンクオブジェクトクラスを作成します。
- Inherited From:
Returns:
ハイパーリンクオブジェクトクラス
- Type
- pmuobjlink
createobjnotebox() → {pmuobjnotebox}
注釈(BOX)クラスを作成します。
- Inherited From:
Returns:
注釈(BOX)クラス
- Type
- pmuobjnotebox
createobjnotefreetext() → {pmuobjnotefreetext}
注釈(FREETEXT)クラスを作成します。
- Inherited From:
Returns:
注釈(FREETEXT)クラス
- Type
- pmuobjnotefreetext
createobjnotehighlight() → {pmuobjnotehighlight}
注釈(HIGHLIGHT)クラスを作成します。
- Inherited From:
Returns:
注釈(HIGHLIGHT)クラス
- Type
- pmuobjnotehighlight
createobjnotepolygon() → {pmuobjnotepolygon}
注釈(POLYGON)クラスを作成します。
- Inherited From:
Returns:
注釈(POLYGON)クラス
- Type
- pmuobjnotepolygon
createobjpagenumber() → {pmuobjpage}
PDF出力時に追記するページ番号オブジェクトクラスを作成します。
- Inherited From:
Returns:
ページ番号オブジェクトクラス
- Type
- pmuobjpage
createobjtext() → {pmuobjtext}
PDF出力時に追記するテキスト枠オブジェクトクラスを作成します。
- Inherited From:
Returns:
テキスト枠オブジェクトクラス
- Type
- pmuobjtext
createobjtrans() → {pmuobjtrans}
PDF出力時に追記する透過オブジェクトクラスを作成します。
- Inherited From:
Returns:
透過オブジェクトクラス
- Type
- pmuobjtrans
createobjwatermark() → {pmuobjwatermark}
PDF出力時に追記するウォーターマークオブジェクトクラスを作成します。
- Inherited From:
Returns:
ウォーターマークオブジェクトクラス
- Type
- pmuobjwatermark
extract(dst) → {Number}
extractaddpage()で指定されたページを抽出します。
また、extractaddpage()で同じページを複数回指定すると、エラーを返します。
また、extractaddpage()で同じページを複数回指定すると、エラーを返します。
Parameters:
Name | Type | Description |
---|---|---|
dst |
String | 抽出結果を出力するPDFファイル名 |
- Inherited From:
- See:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
extractaddpage(pagetype, pageno1, pageno2) → {Number}
ページ抽出の対象ページを追加設定します。
ページ番号を指定する際は、1ページ目を「1」として指定してください。
ページ番号を指定する際は、1ページ目を「1」として指定してください。
Parameters:
Name | Type | Description |
---|---|---|
pagetype |
String | 以下のページ指定の種類を指定します。 "ALL":全て "FROM":指定ページ以降 "FROMTO":範囲指定 "PAGE":特定のページ "TO":指定ページ迄 |
pageno1 |
Number | ページ番号1 |
pageno2 |
Number | ページ番号2(FROMTOの場合のみ使用) |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
Examples
// ページ抽出の対象ページを追加設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "FROMTO":範囲指定
// @param {Number} pageno1 ページ番号1 ⇒ "FROMTO":1ページから
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO":3ページまで
var result = dst.extractaddpage("FROMTO", 1, 3);
// ページ抽出の対象ページを追加設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "PAGE":特定のページ
// @param {Number} pageno1 ページ番号1 ⇒ "PAGE":5ページ指定
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO"ではないため、0を指定
var result = dst.extractaddpage("PAGE", 5, 0);
extractaddpagerotate(pagetype, pageno1, pageno2, rotate) → {Number}
ページ抽出の対象ページを、回転角度付きで追加設定します。
ページ番号を指定する際は、1ページ目を「1」として指定してください。
ページ番号を指定する際は、1ページ目を「1」として指定してください。
Parameters:
Name | Type | Description |
---|---|---|
pagetype |
String | 以下のページ指定の種類を指定します。 "ALL":全て "FROM":指定ページ以降 "FROMTO":範囲指定 "PAGE":特定のページ "TO":指定ページ迄 |
pageno1 |
Number | ページ番号1 |
pageno2 |
Number | ページ番号2(FROMTOの場合のみ使用) |
rotate |
Number | 90度単位で角度を指定 |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
Examples
// ページ抽出の対象ページを追加設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "FROMTO":範囲指定
// @param {Number} pageno1 ページ番号1 ⇒ "FROMTO":1ページから
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO":3ページまで
// @param {Number} rotate 90度単位で角度を指定 ⇒ 90度回転
var result = dst.extractaddpagerotate("FROMTO", 1, 3, 90);
// ページ抽出の対象ページを追加設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "FROM":指定ページ以降
// @param {Number} pageno1 ページ番号1 ⇒ "FROM":3ページから
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO"ではないため、0を指定
// @param {Number} rotate 90度単位で角度を指定 ⇒ 90度単位で切り捨てられるため、180度回転
var result = dst.extractaddpagerotate("FROM", 3, 0, 225);
extractend() → {Number}
抽出処理の終了処理を行います。
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
extractinit(src, passwd) → {Number}
ページ抽出の為の準備処理を行います。
Parameters:
Name | Type | Description |
---|---|---|
src |
String | ページを抽出するPDFファイル名 |
passwd |
String | ページを抽出するPDFファイルのパスワード |
- Inherited From:
Returns:
正常時:ページを抽出するPDFのページ数, エラー時:負の値
- Type
- Number
extractresetpage() → {Number}
抽出ページをリセットします。
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
fastwebview(existingfile, passwd, newfile) → {Number}
指定されたPDFファイルをWeb用に最適化した状態にします。
Parameters:
Name | Type | Description |
---|---|---|
existingfile |
String | 最適化するPDFファイル名 |
passwd |
String | 最適化するPDFファイルのセキュリティパスワード(あれば) |
newfile |
String | 最適化後のファイル名 |
- Inherited From:
Returns:
- Type
- Number
geterror() → {String}
最後のエラーの要因メッセージを返します。
- Inherited From:
Returns:
エラーの要因メッセージ
- Type
- String
geterrorno() → {Number}
最後のエラー要因(数値)を返します。
- Inherited From:
Returns:
エラー要因(数値)
- Type
- Number
getnpagedivname(index) → {String}
分割(npagediv)で出力されたPDFファイルのファイル名を取得します。
Parameters:
Name | Type | Description |
---|---|---|
index |
Number | ファイル番号を指定します。 1つ目のファイルを「0」として指定してください。 |
- Inherited From:
- See:
Returns:
正常時はファイル名を返します。
エラー時は空の文字列を返します。
エラー時は空の文字列を返します。
- Type
- String
getnpagedivpage(index) → {Number}
分割(npagediv)で出力されたPDFファイルの各ファイルのページ数を取得します。
Parameters:
Name | Type | Description |
---|---|---|
index |
Number | ファイル番号を指定します。 1つ目のファイルを「0」として指定してください。 |
- Inherited From:
- See:
Returns:
正常時はページ数を返します。
エラー時は負の値を返します。
エラー時は負の値を返します。
- Type
- Number
getolroot() → {pmuoutline}
しおり追加の為の一番上のしおりオブジェクトクラスを返します。
- Inherited From:
Returns:
一番上のしおりオブジェクトクラス
- Type
- pmuoutline
getpagedivname(index) → {String}
分割(pagediv)で出力されたPDFファイルのファイル名を取得します。
Parameters:
Name | Type | Description |
---|---|---|
index |
Number | ファイル番号を指定します。 1つ目のファイルを「0」として指定してください。 |
- Inherited From:
- See:
Returns:
正常時はファイル名を返します。
エラー時は空の文字列を返します。
エラー時は空の文字列を返します。
- Type
- String
getversion() → {String}
バージョン(文字列)を返します。
- Inherited From:
Returns:
バージョン(文字列)
- Type
- String
getversionno() → {Number}
バージョン(数値)を返します。
- Inherited From:
Returns:
バージョン(数値)
- Type
- Number
init(etcpathopt) → {Number}
内部メンバの初期化等を行います。環境ファイルパスを指定できます。
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
etcpath |
String |
<optional> |
環境ファイルパス |
- Overrides:
Returns:
正常時は0、エラー時は-1を返します。
- Type
- Number
Examples
// 内部メンバの初期化等を行います。環境ファイルパスを指定できます。
// @param {String} [etcpath] 環境ファイルパス
result = edit.init("../../etc");
// 内部メンバの初期化等を行います。環境ファイルパスを指定できます。
// @param {String} [etcpath] 環境ファイルパス ⇒ 引数は省略可能です。
result = edit.init();
initwithetcpath(etcpath) → {Number}
内部メンバの初期化等を行います。環境ファイルパスを指定できます。
Parameters:
Name | Type | Description |
---|---|---|
etcpath |
String | 環境ファイルパス |
- Inherited From:
Returns:
正常時は0、エラー時は-1を返します。
- Type
- Number
npagediv(inpdf, securitypassword, outputformat, npage) → {Number}
PDFファイルをNページ毎に分割します。
setdivoptnpage()で指定した値は反映されません。
setdivoptnpage()で指定した値は反映されません。
Parameters:
Name | Type | Description |
---|---|---|
inpdf |
String | 分割するPDFファイルのファイル名 |
securitypassword |
String | 分割するPDFファイルのセキュリティ設定用のパスワード |
outputformat |
String | 出力ファイル名を決定する為のprintf書式 |
npage |
String | 分割単位を指定します。 |
- Inherited From:
- See:
Returns:
正常時は出力されたファイル数を返します。
エラー時は負の値を返します。
エラー時は負の値を返します。
- Type
- Number
olfromcsv(csv, delimiter, code) → {Number}
CSVファイルからしおりを設定
Parameters:
Name | Type | Description |
---|---|---|
csv |
String | CSVファイル名 |
delimiter |
String | Number | 1文字の区切り文字 2文字以上が指定された場合は、1文字目のみ使用 文字コード(Unicode)で指定も可能 |
code |
Number | CSVの文字コードを以下から指定します。 "DEFAULT":デフォルト "ASCII":ASCII "JPSJIS":日本語SJISコード "UTF8":UTF-8 |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
Examples
// CSVファイルからしおりを設定
// @param {String} csv CSVファイル名
// @param {String} delimiter 区切り文字
// @param {String} code CSVの文字コードを指定します。 ⇒ "DEFAULT":デフォルト
var result = dst.olfromcsv("sample.csv", ",", "DEFAULT");
// CSVファイルからしおりを設定
// @param {String} csv CSVファイル名
// @param {Number} delimiter 区切り文字 ⇒ 44:","(Unicode)
// 文字コード(Unicode)で指定も可能
// @param {String} code CSVの文字コードを指定します。 ⇒ "ASCII":ASCII
var result = dst.olfromcsv("sample.csv", 44, "ASCII");
oloutputpdf(pdfsrc, pdfdst) → {Number}
しおりを設定したPDFファイルを出力
Parameters:
Name | Type | Description |
---|---|---|
pdfsrc |
String | 設定元のPDFファイル名 |
pdfdst |
String | 設定後のPDFファイル名 |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
oloutputpdfex(pdfsrc, srcpasswd, pdfdst) → {Number}
しおりを設定したPDFファイルを出力
Parameters:
Name | Type | Description |
---|---|---|
pdfsrc |
String | 設定元のPDFファイル名 |
srcpasswd |
String | 設定元のPDFファイルのパスワード |
pdfdst |
String | 設定後のPDFファイル名 |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
openoutput(filename) → {Number}
出力PDFをオープンします。
Parameters:
Name | Type | Description |
---|---|---|
filename |
String | 出力PDF |
Returns:
- Type
- Number
opensrcpdf(filename, passwd) → {pmueditsrc}
ページ配置するPDFをオープンします。
Parameters:
Name | Type | Description |
---|---|---|
filename |
String | ページ配置するPDF |
passwd |
String | ページ配置するPDFのパスワード |
Returns:
ページ配置するPDFのpmueditsrcクラス。
エラーの場合はnull。
エラーの場合はnull。
- Type
- pmueditsrc
outpage() → {Number}
ページ配置してページを出力します。
Returns:
- Type
- Number
outputpdf(filename) → {Number}
指定された切出し元のPDF、及び、追記オブジェクトを指定されたファイルにPDF出力します。
Parameters:
Name | Type | Description |
---|---|---|
filename |
String | 出力先のPDFファイルのファイル名 |
- Inherited From:
Returns:
- Type
- Number
pagediv(inpdf, securitypassword, outputformat) → {Number}
PDFファイルを1ページ単位で分割します。
複数ページ単位で分割する場合は、setdivoptnpage()で分割単位を設定してください。
複数ページ単位で分割する場合は、setdivoptnpage()で分割単位を設定してください。
Parameters:
Name | Type | Description |
---|---|---|
inpdf |
String | 分割するPDFファイルのファイル名 |
securitypassword |
String | 分割するPDFファイルセキュリティ設定用のパスワード |
outputformat |
String | 出力ファイル名を決定する為のprintf書式 |
- Inherited From:
- See:
Returns:
正常時は出力されたファイル数を返します。
エラー時は負の値を返します。
エラー時は負の値を返します。
- Type
- Number
release()
内部のハンドルを開放します。
- Overrides:
samedirection(pdf, pdfpasswd, outpdf, dir, angle) → {Number}
用紙方向を揃えます。
Parameters:
Name | Type | Description |
---|---|---|
pdf |
String | 対象PDFファイル名を指定します。 |
pdfpasswd |
String | 対象PDFのセキュリティパスワードを指定します。 |
outpdf |
String | 出力先のPDFファイル名を指定します。 |
dir |
String | 以下の用紙方向揃えオプションを指定します。 "PORTRAIT":横方向のページのみ回転します。 "LANDSCAPE":縦方向のページのみ回転します。 "ANGLE":全てのページを回転します。 |
angle |
Number | 回転する角度を90度単位で指定します。 |
- Inherited From:
Returns:
正常時:PDFのページ数, エラー時:負の値
- Type
- Number
Examples
// 用紙方向を揃えます。
// @param {String} pdf 対象PDFファイル名を指定します。
// @param {String} pdfpasswd 対象PDFのセキュリティパスワードを指定します。
// @param {String} outpdf 出力先のPDFファイル名を指定します。
// @param {String} dir 用紙方向揃えオプションを指定します。 ⇒ "ANGLE":全てのページを回転します。
// @param {Number} angle 回転が必要になった場合の角度を指定します。 ⇒ 90度回転
var pageCount = dst.samedirection("source.pdf", "password", "destination.pdf", "ANGLE", 90);
// 用紙方向を揃えます。
// @param {String} pdf 対象PDFファイル名を指定します。
// @param {String} pdfpasswd 対象PDFのセキュリティパスワードを指定します。 ⇒ パスワード無しのため、nullを指定
// @param {String} outpdf 出力先のPDFファイル名を指定します。
// @param {String} dir 用紙方向揃えオプションを指定します。 ⇒ "PORTRAIT":横方向のページのみ回転します。
// @param {Number} angle 回転が必要になった場合の角度を指定します。 ⇒ 横方向のページのみ90度回転
var pageCount = dst.samedirection("source.pdf", null, "destination.pdf", "PORTRAIT", 90);
setcleanflags(flags) → {Number}
不要な情報のチェックを行う内容を設定します。
また、ここで設定した値は、outputpdf()、cleanpdf()関数の処理で使用されます。
また、ここで設定した値は、outputpdf()、cleanpdf()関数の処理で使用されます。
Parameters:
Name | Type | Description |
---|---|---|
flags |
Array.<String> | 以下の内容から、チェックする項目全てを配列の要素として指定します。 ・"FONT":不要なフォントを削除 ・"APPDATA":不要なアプリケーション固有データを削除 ・"UPDATETIMESTAMP":文書情報のタイムスタンプを更新 ・"IMAGE":同一画像情報を統合 全てチェックする場合は"ALL"を、全てチェックしない場合は"NONE"を、配列の単一要素として指定してください。 |
- Inherited From:
- See:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
Examples
// 不要な情報のチェックを行う内容を設定します。
// @param {String[]} flags チェックする項目全てを配列の要素として指定します。 ⇒
// "FONT":不要なフォントを削除/"UPDATETIMESTAMP":文書情報のタイムスタンプを更新/"IMAGE":同一画像情報を統合
var result = dst.setcleanflags(["FONT", "UPDATETIMESTAMP", "IMAGE"]);
// 不要な情報のチェックを行う内容を設定します。
// @param {String[]} flags チェックする項目全てを配列の要素として指定します。 ⇒ "ALL":全てチェック
var result = dst.setcleanflags(["ALL"]);
setdivoptnpage(npage) → {Number}
分割時の分割単位オプションを設定します。
設定した値はpagediv()にのみ反映され、npagediv()には反映されません。
設定した値はpagediv()にのみ反映され、npagediv()には反映されません。
Parameters:
Name | Type | Description |
---|---|---|
npage |
Number | 分割単位(ページ数)を指定します。 |
- Inherited From:
- See:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
setdivoptsamedirection(dir, angle) → {Number}
分割時の用紙方向揃えオプションを設定します。
Parameters:
Name | Type | Description |
---|---|---|
dir |
String | 用紙方向揃えオプションを指定します。 "NONE":回転を行いません。 "PORTRAIT":横方向のページのみ回転します。 "LANDSCAPE":縦方向のページのみ回転します。 "ANGLE":全てのページを回転します。 |
angle |
Number | 回転する角度を90度単位で指定します。 |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
Examples
// 分割時の用紙方向揃えオプションを設定します。
// @param {String} dir 用紙方向揃えオプションを指定します。⇒ "ANGLE":全てのページを回転します。
// @param {Number} angle 回転する角度を90度単位で指定します。 ⇒ 90度回転
var result = dst.setdivoptsamedirection("ANGLE", 90);
// 分割時の用紙方向揃えオプションを設定します。
// @param {String} dir 用紙方向揃えオプションを指定します。⇒ "LANDSCAPE":縦方向のページのみ回転します。
// @param {Number} angle 回転する角度を90度単位で指定します。 ⇒ 縦方向のページのみ90度回転
var result = dst.setdivoptsamedirection("LANDSCAPE", 90);
setdocinfo(title, subtitle, creator, app, keyword) → {Number}
PDF出力時に設定する文書情報を指定します。
Parameters:
Name | Type | Description |
---|---|---|
title |
String | タイトル |
subtitle |
String | サブタイトル |
creator |
String | 作成者 |
app |
String | アプリケーション |
keyword |
String | キーワード |
- Inherited From:
Returns:
- Type
- Number
Example
// 出力PDFの文書情報を設定します。
// @param {String} title タイトルに設定する文字列を指定します。
// @param {String} subtitle サブタイトルに設定する文字列を指定します。
// @param {String} creator 作成者に設定する文字列を指定します。
// @param {String} app 作成アプリケーションに設定する文字列を指定します。
// @param {String} keyword キーワードに設定する文字列を指定します。
dst.setdocinfo("タイトル", "サブタイトル", "作成者", "アプリケーション", "キーワード");
setfastwebview(bfastewbview) → {Number}
追記、しおり追加等を行い、PDF出力後に、Webに最適化を行うかどうかを設定します。
Parameters:
Name | Type | Description |
---|---|---|
bfastewbview |
boolean | 最適化する/しない |
- Inherited From:
Returns:
- Type
- Number
setopeningpage(mode, page, zoom) → {Number}
ページの初期表示状態を設定します。
Parameters:
Name | Type | Description |
---|---|---|
mode |
String | 初期表示するモードを指定します。 "NONE":初期表示の情報を変更しません。 "NOOUTPUT":初期表示の情報を出力しません。 "PAGE":ページ全体を表示します。 "PAGEWIDTH":幅に合わせて表示します。 "PAGEHEIGHT":高さに合わせて表示します。 "DRAWWIDTH":余白を除く幅に合わせて表示します。 "ZOOM":zoomに指定した値の倍率で表示します。 "ZOOM100":100表示します。 このメソッドの呼び出しを省略した場合は"NONE"となります。 |
page |
Number | 初期表示するページ番号を指定します。 1ページ目を「1」として指定してください。 |
zoom |
Number | 初期表示の倍率を指定します。modeが"ZOOM"の場合のみ使用されます。 指定する際は整数値を入力してください。 |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
Examples
// ページの初期表示状態を設定します。
// @param {String} mode 初期表示するモードを指定します。 ⇒ "ZOOM":zoomに指定した値の倍率で表示します。
// @param {Number} page 初期表示するページ番号を指定します。 ⇒ 2ページを初期表示指定
// @param {Number} zoom 初期表示の倍率を指定します。modeが"ZOOM"の場合のみ使用されます。 ⇒ "ZOOM":120%表示
var result = dst.setopeningpage("ZOOM", 2, 120);
// ページの初期表示状態を設定します。
// @param {String} mode 初期表示するモードを指定します。 ⇒ "PAGEWIDTH":幅に合わせて表示します。
// @param {Number} page 初期表示するページ番号を指定します。 ⇒ 2ページを初期表示指定
// @param {Number} zoom 初期表示の倍率を指定します。modeが"ZOOM"の場合のみ使用されます。 ⇒ "ZOOM"ではないため、0を指定
var result = dst.setopeningpage("PAGEWIDTH", 2, 0);
setopeningpagelayout(mode) → {Number}
初期表示時のページレイアウトを指定します。
Parameters:
Name | Type | Description |
---|---|---|
mode |
String | 初期表示時のページレイアウト "NOOUTPUT": デフォルト "SINGLEPAGE": 単一ページ "ONECOLUMN": 連続ページ "TWOCOLUMNLEFT": 連続見開きページ "TWOCOLUMNRIGHT": 連続見開きページ(表紙) "TWOPAGELEFT": 見開きページ "TWOPAGERIGHT": 見開きページ(表紙) |
- Inherited From:
Returns:
- Type
- Number
Example
// 初期表示時のページレイアウトを指定します。
// @param {String} mode 初期表示時のページレイアウト ⇒ "ONECOLUMN": 連続ページ
dst.setopeningpagelayout("ONECOLUMN");
setopeningpanel(mode) → {Number}
パネルの初期表示状態を設定します。
Parameters:
Name | Type | Description |
---|---|---|
mode |
String | 初期表示するモードを指定します。 "NONE":初期表示の情報を変更しません。 "NOOUTPUT":初期表示の情報を出力しません。 "NORMAL":パネル表示をしません。 "OUTLINE":しおりを表示。 "LAYER":レイヤを表示。 "THUMBNAIL":ページのサムネールを表示 "ATTACHMENT":添付ファイルを表示 この関数の呼び出しを省略した場合は"NONE"となります。 |
- Inherited From:
Returns:
- Type
- Number
Example
// パネルの初期表示状態を設定します。
// @param {String} mode 初期表示するモードを指定します。 ⇒ "LAYER":レイヤを表示。
dst.setopeningpanel("LAYER");
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);
setoutputpagesize(width, height) → {Number}
ページ出力時のページサイズを設置します。
Parameters:
Name | Type | Description |
---|---|---|
width |
Number | ページ幅 |
height |
Number | ページ高さ |
Returns:
- Type
- Number
setpdfamode(bpdfamode, reserved) → {Number}
Parameters:
Name | Type | Description |
---|---|---|
bpdfamode |
boolean | |
reserved |
Number |
- Inherited From:
Returns:
- Type
- Number
setpdfproperty(src, passwd, dst) → {Number}
指定PDFファイルに文書情報とセキュリティを設定します。
Parameters:
Name | Type | Description |
---|---|---|
src |
String | 設定対象のPDF |
passwd |
String | 設定対象のPDFのパスワード |
dst |
String | 出力先のPDF |
- Inherited From:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
setsecurity(openpassword, securitypassword, noprint, noedit, nocopy, noaddnote) → {Number}
PDF出力時に設定するRC4 40ビットセキュリティ情報を指定します。
Parameters:
Name | Type | Description |
---|---|---|
openpassword |
String | 参照用のパスワード |
securitypassword |
String | セキュリティ設定用のパスワード |
noprint |
boolean | 印刷を許可しない。 |
noedit |
boolean | 編集を許可しない。 |
nocopy |
boolean | 転載を許可しない。 |
noaddnote |
boolean | 注釈追加を許可しない。 |
- Inherited From:
Returns:
- Type
- Number
setsecurity40byflags(openpassword, securitypassword, flags) → {Number}
PDF出力時に設定するRC4 40ビットセキュリティ情報を指定します。
Parameters:
Name | Type | Description |
---|---|---|
openpassword |
String | 参照用のパスワード |
securitypassword |
String | セキュリティ設定用のパスワード |
flags |
Number | セキュリティ値 |
- Inherited From:
Returns:
- Type
- Number
setsecurity128(openpassword, securitypassword, print, acc, copy, change) → {Number}
PDF出力時に設定するRC4 128ビットセキュリティ情報を指定します。
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":許可する |
- Inherited From:
Returns:
- Type
- Number
Example
// PDF出力時に設定するRC4 128ビットセキュリティ情報を指定します。
// @param {String} openpassword 参照用のパスワード
// @param {String} securitypassword セキュリティ設定用のパスワード
// @param {String} print 印刷 ⇒ "PRINT_DEGRADED":低解像度で許可する
// @param {String} acc アクセス ⇒ "ACC_DISABLE":許可しない
// @param {String} copy 転載 ⇒ "COPY_ENABLE":許可する
// @param {String} change 文書変更 ⇒ "DOCCHANGE_ADDNOTE":フォーム入力と注釈追加を許可する
dst.setsecurity128("open", "sec", "PRINT_DEGRADED", "ACC_DISABLE", "COPY_ENABLE", "DOCCHANGE_ADDNOTE");
setsecurity128byflags(openpassword, securitypassword, flags) → {Number}
PDF出力時に設定するRC4 128ビットセキュリティ情報を指定します。
Parameters:
Name | Type | Description |
---|---|---|
openpassword |
String | 参照用のパスワード |
securitypassword |
String | セキュリティ設定用のパスワード |
flags |
Number | セキュリティ値 |
- Inherited From:
Returns:
- Type
- Number
setsecurityaes128(openpassword, securitypassword, print, acc, copy, change) → {Number}
PDF出力時に設定するAES 128ビットセキュリティ情報を指定します。
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":許可する |
- Inherited From:
Returns:
- Type
- Number
Example
// PDF出力時に設定するAES 128ビットセキュリティ情報を指定します。
// @param {String} openpassword 参照用のパスワード
// @param {String} securitypassword セキュリティ設定用のパスワード
// @param {String} print 印刷 ⇒ "PRINT_DEGRADED":低解像度で許可する
// @param {String} acc アクセス ⇒ "ACC_DISABLE":許可しない
// @param {String} copy 転載 ⇒ "COPY_ENABLE":許可する
// @param {String} change 文書変更 ⇒ "DOCCHANGE_ADDNOTE":フォーム入力と注釈追加を許可する
dst.setsecurityaes128("open", "sec", "PRINT_DEGRADED", "ACC_DISABLE", "COPY_ENABLE", "DOCCHANGE_ADDNOTE");
setsecurityaes128byflags(openpassword, securitypassword, flags) → {Number}
PDF出力時に設定するAES 128ビットセキュリティ情報を指定します。
Parameters:
Name | Type | Description |
---|---|---|
openpassword |
String | 参照用のパスワード |
securitypassword |
String | セキュリティ設定用のパスワード |
flags |
Number | セキュリティ値 |
- Inherited From:
Returns:
- Type
- Number
settemppath(temppath) → {Number}
処理中で使用する、一時ファイルの作成先を指定します。
Parameters:
Name | Type | Description |
---|---|---|
temppath |
String | 一時ファイルの作成先 |
- Overrides:
Returns:
正常時:0, エラー時:負の値
- Type
- Number
strtobyte(bstr) → {Array.<Number>}
StringをバイナリとしてNumber[]に変換して返します。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
Parameters:
Name | Type | Description |
---|---|---|
bstr |
String | 変換を行う文字列 |
- Inherited From:
Returns:
strがヌルの場合は、ヌルを返します。
m_encodeが、ヌルの場合はstr.getBytes()を返します。
m_encodeが、ヌルでない場合はstr.getBytes(m_encode)を 返します。
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");