Class: pmudst

// PDF出力制御クラスのインスタンスを生成します。
var dst = new pmudst();

Extends

• pdfmakeup

Members

m_encode

Properties:

Overrides:

• pdfmakeup#m_encode

Example

// @property {String} m_encode getBytesなどで使用するエンコード文字列です。
dst.m_encode = "MS932";

Methods

addobjoutputpdf(filename) → {Number}

Parameters:

Returns:

Type

Number

addpage(src, page) → {Number}

Parameters:

Returns:

Type

Number

addpagerotate(src, page, rotate) → {Number}

Parameters:

Returns:

Type

Number

addsrcfile(filename, passwd) → {Number}

Parameters:

Returns:

Type

Number

addsrcfilefast(filename, passwd, busetmp) → {Number}

Parameters:

Returns:

Type

Number

bytetostr(bstr) → {String}

Parameters:

Inherited From:

• pdfmakeup#bytetostr

Returns:

Type

String

Example

// バイナリのNumber[]をStringに変換して返します。
// 使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
// @param {Number[]} bstr 変換を行う配列
makeup.m_encode = "MS932";
var convertedString = makeup.bytetostr(binaryArray);

cleanpdf(filename, passwd, dst) → {Number}

Parameters:

See:

• #setcleanflags

Returns:

Type

Number

createjavascript(page) → {pmujavascript}

Parameters:

Returns:

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");

createobj(objtype) → {pmuobjformbutton|pmuobjformtext|pmuobjnotebox|pmuobjnotefreetext|pmuobjnotehighlight|pmuobjnotepolygon|pmuobjimage|pmuobjiod|pmuobjlink|pmuobjpage|pmuobjtext|pmuobjtrans|pmuobjwatermark}

Parameters:

Returns:

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}

Returns:

Type

pmuobjformbutton

createobjformtext() → {pmuobjformtext}

Returns:

Type

pmuobjformtext

createobjimage() → {pmuobjimage}

Returns:

Type

pmuobjimage

createobjiod() → {pmuobjiod}

Returns:

Type

pmuobjiod

createobjlink() → {pmuobjlink}

Returns:

Type

pmuobjlink

createobjnotebox() → {pmuobjnotebox}

Returns:

Type

pmuobjnotebox

createobjnotefreetext() → {pmuobjnotefreetext}

Returns:

Type

pmuobjnotefreetext

createobjnotehighlight() → {pmuobjnotehighlight}

Returns:

Type

pmuobjnotehighlight

createobjnotepolygon() → {pmuobjnotepolygon}

Returns:

Type

pmuobjnotepolygon

createobjpagenumber() → {pmuobjpage}

Returns:

Type

pmuobjpage

createobjtext() → {pmuobjtext}

Returns:

Type

pmuobjtext

createobjtrans() → {pmuobjtrans}

Returns:

Type

pmuobjtrans

createobjwatermark() → {pmuobjwatermark}

Returns:

Type

pmuobjwatermark

extract(dst) → {Number}

Parameters:

See:

• #extractaddpage

Returns:

Type

Number

extractaddpage(pagetype, pageno1, pageno2) → {Number}

Parameters:

Returns:

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}

Parameters:

Returns:

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}

Returns:

Type

Number

extractinit(src, passwd) → {Number}

Parameters:

Returns:

Type

Number

extractresetpage() → {Number}

Returns:

Type

Number

fastwebview(existingfile, passwd, newfile) → {Number}

Parameters:

Returns:

Type

Number

geterror() → {String}

Inherited From:

• pdfmakeup#geterror

Returns:

Type

String

geterrorno() → {Number}

Inherited From:

• pdfmakeup#geterrorno

Returns:

Type

Number

getnpagedivname(index) → {String}

Parameters:

See:

• #npagediv

Returns:

Type

String

getnpagedivpage(index) → {Number}

Parameters:

See:

• #npagediv

Returns:

Type

Number

getolroot() → {pmuoutline}

Returns:

Type

pmuoutline

getpagedivname(index) → {String}

Parameters:

See:

• #pagediv

Returns:

Type

String

getversion() → {String}

Inherited From:

• pdfmakeup#getversion

Returns:

Type

String

getversionno() → {Number}

Inherited From:

• pdfmakeup#getversionno

Returns:

Type

Number

init() → {Number}

Returns:

Type

Number

initwithetcpath(etcpath) → {Number}

Parameters:

Returns:

Type

Number

npagediv(inpdf, securitypassword, outputformat, npage) → {Number}

Parameters:

See:

• #setdivoptnpage

Returns:

Type

Number

olfromcsv(csv, delimiter, code) → {Number}

Parameters:

Returns:

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}

Parameters:

Returns:

Type

Number

oloutputpdfex(pdfsrc, srcpasswd, pdfdst) → {Number}

Parameters:

Returns:

Type

Number

outputpdf(filename) → {Number}

Parameters:

Returns:

Type

Number

pagediv(inpdf, securitypassword, outputformat) → {Number}

Parameters:

See:

• #setdivoptnpage

Returns:

Type

Number

release()

samedirection(pdf, pdfpasswd, outpdf, dir, angle) → {Number}

Parameters:

Returns:

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}

Parameters:

See:

• #outputpdf
• #cleanpdf

Returns:

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}

Parameters:

See:

• #pagediv
• #npagediv

Returns:

Type

Number

setdivoptsamedirection(dir, angle) → {Number}

Parameters:

Returns:

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}

Parameters:

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}

Parameters:

Returns:

Type

Number

setopeningpage(mode, page, zoom) → {Number}

Parameters:

Returns:

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:

Returns:

Type

Number

Example

// 初期表示時のページレイアウトを指定します。
// @param {String} mode 初期表示時のページレイアウト ⇒ "ONECOLUMN": 連続ページ
dst.setopeningpagelayout("ONECOLUMN");

setopeningpanel(mode) → {Number}

Parameters:

Returns:

Type

Number

Example

// パネルの初期表示状態を設定します。
// @param {String} mode 初期表示するモードを指定します。 ⇒ "LAYER":レイヤを表示。
dst.setopeningpanel("LAYER");

setoptionvalue(optiontype, optionvalue) → {Number}

Parameters:

Inherited From:

• pdfmakeup#setoptionvalue

Returns:

Type

Number

Example

// 各種オプションを設定します。
// @param {String} optiontype オプションの種類を表す文字列 ⇒ "PORTFOLIOERROR":ポートフォリオファイルをエラーにする
// @param {Number} optionvalue
makeup.setoptionvalue("PORTFOLIOERROR", 1);

setpdfamode(bpdfamode, reserved) → {Number}

Parameters:

Inherited From:

• pdfmakeup#setpdfamode

Returns:

Type

Number

setpdfproperty(src, passwd, dst) → {Number}

Parameters:

Returns:

Type

Number

setsecurity(openpassword, securitypassword, noprint, noedit, nocopy, noaddnote) → {Number}

Parameters:

Returns:

Type

Number

setsecurity40byflags(openpassword, securitypassword, flags) → {Number}

Parameters:

Returns:

Type

Number

setsecurity128(openpassword, securitypassword, print, acc, copy, change) → {Number}

Parameters:

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}

Parameters:

Returns:

Type

Number

setsecurityaes128(openpassword, securitypassword, print, acc, copy, change) → {Number}

Parameters:

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}

Parameters:

Returns:

Type

Number

settemppath(temppath) → {Number}

Parameters:

Returns:

Type

Number

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

Parameters:

Inherited From:

• pdfmakeup#strtobyte

Returns:

Type

Array.<Number>

Example

// StringをバイナリとしてNumber[]に変換して返します。
// 使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
// @param {String} bstr 変換を行う文字列
makeup.m_encode = "MS932";
var binaryString = strtobyte("sample");