JSDoc: Class: pmusrc

Constructor

new pmusrc()

インスタンスオブジェクトの作成。

Author:

株式会社ワイ・エス・エス

Returns:

生成されたインスタンスオブジェクト

Example

// 入力ファイルのクラスのインスタンスを生成します。
var src = new pmusrc();

Extends

pdfmakeup

Members

m_encode

Properties:

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

Overrides:

pdfmakeup#m_encode

Example

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

Methods

bytetostr(bstr) → {String}

バイナリのNumber[]をStringに変換して返します。
アプリケーション側で何らかの事情でエンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。

Parameters:

Name	Type	Description
`bstr`	Array.<Number>	変換を行う配列

Inherited From:

pdfmakeup#bytetostr

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

getdocinfo(infotype) → {String}

文書情報を文字列で返します。

Parameters:

Name	Type	Description
`infotype`	String	以下の文書情報の種類を指定します。 "APP":アプリケーション "CONVERTER":PDF変換プログラム "CREATOR":作成者 "FASTWEBVIEW":Web用に最適化の状況 "ISPDFA":PDF/Aか否か "KEYWORD":キーワード "OPENINGPAGE":ページの初期表示の種類 "OPENINGPAGELAYOUT":初期表示のページレイアウト "OPENINGPAGEPAGE":ページの初期表示のページ番号 "OPENINGPAGEZOOM":ページの初期表示の表示縮尺 "OPENINGPANEL":初期表示のパネル "PDFAVERSION":PDF/Aのバージョン "PDFVERSIONNO":PDF形式のバージョン/番号形式 "PDFVERSIONSTR":PDF形式のバージョン/文字列形式 "PORTFOLIO":ポートフォリオファイルか "SUBTITLE":サブタイトル "TITLE":タイトル "XFAFORM":XFA Formファイルか

Returns:

infotypeで指定した情報の文字列を返します。
また、オープンされていない、読取エラー等の場合はnullを返します。

Type: String

Example

// 文書情報を文字列で返します。
// @param {String} infotype 文書情報の種類を指定します。 ⇒ "KEYWORD":キーワード
var keyrowd = src.getdocinfo("KEYWORD");

getdocinfovalue(infotype) → {Number}

文書情報を値で返します。

Parameters:

Name	Type	Description
`infotype`	String	以下の文書情報の種類を指定します。 "APP":アプリケーション "CONVERTER":PDF変換プログラム "CREATOR":作成者 "FASTWEBVIEW":Web用に最適化の状況 "ISPDFA":PDF/Aか否か "KEYWORD":キーワード "OPENINGPAGE":ページの初期表示の種類 "OPENINGPAGELAYOUT":初期表示のページレイアウト "OPENINGPAGEPAGE":ページの初期表示のページ番号 "OPENINGPAGEZOOM":ページの初期表示の表示縮尺 "OPENINGPANEL":初期表示のパネル "PDFAVERSION":PDF/Aのバージョン "PDFVERSIONNO":PDF形式のバージョン/番号形式 "PDFVERSIONSTR":PDF形式のバージョン/文字列形式 "PORTFOLIO":ポートフォリオファイルか "SUBTITLE":サブタイトル "TITLE":タイトル "XFAFORM":XFA Formファイルか

Returns:

infotypeで指定した情報の値を返します。
また、文字列タイプを指定した場合は0を返します。

Type: Number

Example

// 文書情報を文字列で返します。
// @param {String} infotype 文書情報の種類を指定します。 ⇒ "OPENINGPAGELAYOUT":初期表示のページレイアウト
var openingpagelayout = src.getdocinfovalue("OPENINGPAGELAYOUT");

geterror() → {String}

最後のエラーの要因メッセージを返します。

Inherited From:

pdfmakeup#geterror

Returns:

エラーの要因メッセージ

Type: String

geterrorno() → {Number}

最後のエラー要因(数値)を返します。

Inherited From:

pdfmakeup#geterrorno

Returns:

エラー要因(数値)

Type: Number

getpagecount() → {Number}

オープンした切出し元のPDFのページ数を返します。

Returns:

オープンした切出し元のPDFのページ数

Type: Number

getpageinfo(page) → {pmupageinfo}

指定ページのページ情報を返します。

Parameters:

Name	Type	Description
`page`	Number	指定ページ

Returns:

PDFのページ情報クラス

Type: pmupageinfo

getsecurityinfo() → {pmusecinfo}

セキュリティ情報クラスを返します。

Returns:

セキュリティ情報クラス

Type: pmusecinfo

getversion() → {String}

バージョン(文字列)を返します。

Inherited From:

pdfmakeup#getversion

Returns:

バージョン(文字列)

Type: String

getversionno() → {Number}

バージョン(数値)を返します。

Inherited From:

pdfmakeup#getversionno

Returns:

バージョン(数値)

Type: Number

init() → {Number}

内部メンバの初期化等を行います。

Returns:

正常時は0、エラー時は-1を返します。

Type: Number

initwithetcpath(etcpath) → {Number}

内部メンバの初期化等を行います。環境ファイルパスを指定できます。

Parameters:

Name	Type	Description
`etcpath`	String	環境ファイルパス

Returns:

正常時は0、エラー時は-1を返します。

Type: Number

openpdf(filename, passwd) → {Number}

切出し元のPDFファイルをオープンします。

Parameters:

Name	Type	Description
`filename`	String	切り出し元PDF
`passwd`	String	切り出し元PDFのパスワード

Returns:

Type: Number

openpdfforinfo(filename, passwd, level) → {Number}

情報取得用にPDFファイルをオープンします。

Parameters:

Name	Type	Description
`filename`	String	オープンするPDFファイル名を指定します。
`passwd`	String	オープンするPDFのパスワードを指定します。
`level`	Number	現状常に0を指定します。 0以外を指定した場合はエラーとなります。

Returns:

Type: Number

release()

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

setoptionvalue(optiontype, optionvalue) → {Number}

各種オプションを設定します。

Parameters:

Name	Type	Description
`optiontype`	String	オプションの種類を表す文字列 "PORTFOLIOERROR":ポートフォリオファイルをエラーにする "XFAFORMERROR":XFA Formファイルをエラーにする "PAGETREEVALIDATE":ページツリーの整合性をチェックする
`optionvalue`	Number

Inherited From:

pdfmakeup#setoptionvalue

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

Inherited From:

pdfmakeup#setpdfamode

Returns:

Type: Number

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:

pdfmakeup#strtobyte

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