Class: pmuobjnotebox

// BOX型の注釈オブジェクトクラスのインスタンスを生成します。
var objnotebox = new pmuobjnotebox();

Extends

• pmuobjnote

Members

m_encode

Properties:

Overrides:

• pmuobjnote#m_encode

Example

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

Methods

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

geterror() → {String}

Inherited From:

• pdfmakeup#geterror

Returns:

Type

String

geterrorno() → {Number}

Inherited From:

• pdfmakeup#geterrorno

Returns:

Type

Number

getversion() → {String}

Inherited From:

• pdfmakeup#getversion

Returns:

Type

String

getversionno() → {Number}

Inherited From:

• pdfmakeup#getversionno

Returns:

Type

Number

movepos(x, y) → {Number}

Parameters:

Inherited From:

• pmuobj#movepos

Returns:

Type

Number

release()

Inherited From:

• pmuobj#release

setbasepos(postype) → {Number}

Parameters:

Inherited From:

• pmuobj#setbasepos

Returns:

Type

Number

Example

// オブジェクトの基本位置を指定します。
// @param {String} postype 追記オブジェクトの基本位置を指定します。 ⇒ "LT":左上
obj.setbasepos("LT");

setbrushcolor(r, g, b) → {Number}

Parameters:

Inherited From:

• pmuobj#setbrushcolor

Returns:

Type

Number

Example

// 追記オブジェクトが使用するブラシの色を設定します。
// @param {Number} r 赤値
// @param {Number} g 緑値
// @param {Number} b 青値
// 青色を指定
obj.setbrushcolor(0, 0, 255);

setbrushtype(brushtype) → {Number}

Parameters:

Inherited From:

• pmuobj#setbrushtype

See:

• pmuobjnotehighlight

Returns:

Type

Number

Example

// 追記オブジェクトが使用するブラシの種類を設定します。
// ハイライト注釈オブジェクトが対象の場合、"NULL"を指定して呼び出すことは出来ません。
// @param {String} brushtype ブラシの種類を設定します。 ⇒ "COLOR":色付き
obj.setbrushtype("COLOR");

setcreator(creator) → {Number}

Parameters:

Inherited From:

• pmuobjnote#setcreator

Returns:

Type

Number

Example

// 注釈の作成者を設定します。
// @param {String} creator 注釈の作成者
objnote.setcreator("作成者１");

setfont(font) → {Number}

Parameters:

Inherited From:

• pmuobj#setfont

Returns:

Type

Number

Example

// 追記オブジェクトが使用するフォントを設定します。
// @param {String} font フォント名 ⇒ ＭＳ 明朝を指定
obj.setfont("ＭＳ 明朝");

setfontbold(bbold) → {Number}

Parameters:

Inherited From:

• pmuobj#setfontbold

Returns:

Type

Number

setfontcolor(r, g, b) → {Number}

Parameters:

Inherited From:

• pmuobj#setfontcolor

Returns:

Type

Number

Example

// 追記オブジェクトが使用するフォントの色をRGBで設定します。
// @param {Number} r 赤値
// @param {Number} g 緑値
// @param {Number} b 青値
// 赤色を指定
obj.setfontcolor(255, 0, 0);

setfontitalic(bitalic) → {Number}

Parameters:

Inherited From:

• pmuobj#setfontitalic

Returns:

Type

Number

setfontrotate(rotate) → {Number}

Parameters:

Inherited From:

• pmuobj#setfontrotate

Returns:

Type

Number

setfontscale(scale) → {Number}

Parameters:

Inherited From:

• pmuobj#setfontscale

Returns:

Type

Number

setfontsize(fontsize) → {Number}

Parameters:

Inherited From:

• pmuobj#setfontsize

Returns:

Type

Number

setfonttransparent(btransparent) → {Number}

Parameters:

Inherited From:

• pmuobj#setfonttransparent

Returns:

Type

Number

setlayer(layertype) → {Number}

Parameters:

Inherited From:

• pmuobj#setlayer

Returns:

Type

Number

Example

// 追記オブジェクトをオリジナルPDFの上または下のどちらに追記するかを設定します。
// @param {String} layertype 追記位置を設定します。 ⇒ "FRONT":追記オブジェクトをオリジナルの上(前面)に配置
obj.setlayer("FRONT");

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

setpencolor(r, g, b) → {Number}

Parameters:

Inherited From:

• pmuobj#setpencolor

Returns:

Type

Number

Example

// 追記オブジェクトが使用するペンの色を設定します。
// @param {Number} r 赤値
// @param {Number} g 緑値
// @param {Number} b 青値
// 緑色を指定
obj.setpencolor(0, 255, 0);

setpentype(brushtype) → {Number}

Parameters:

Inherited From:

• pmuobj#setpentype

Returns:

Type

Number

Example

// 追記オブジェクトが使用するペンの種類を設定します。
// @param {String} brushtype ペンの種類を設定します。 ⇒ "DASHDOT":一点鎖線
obj.setpentype("DASHDOT");

setpenwidth(penwidth) → {Number}

Parameters:

Inherited From:

• pmuobj#setpenwidth

Returns:

Type

Number

setpopuprect(x, y, w, h) → {Number}

Parameters:

Inherited From:

• pmuobjnote#setpopuprect

Returns:

Type

Number

setpopuptext(str) → {Number}

Parameters:

Inherited From:

• pmuobjnote#setpopuptext

Returns:

Type

Number

Example

// ポップアップ内の文字列を設定します。
// @param {String} str 文字列
objnote.setpopuptext("ポップアップ");

setpos(x, y) → {Number}

Parameters:

Inherited From:

• pmuobj#setpos

Returns:

Type

Number

setprint(print) → {Number}

Parameters:

Inherited From:

• pmuobjnote#setprint

Returns:

Type

Number

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

Parameters:

Inherited From:

• pmuobj#settargetpage

Returns:

Type

Number

Examples

// 追記オブジェクトをどのページに追記するかを設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "FROMTO":範囲指定
// @param {Number} pageno1 ページ番号1 ⇒ "FROMTO":1ページから
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO":3ページまで
obj.settargetpage("FROMTO", 1, 3);

// 追記オブジェクトをどのページに追記するかを設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "PAGE":特定のページ
// @param {Number} pageno1 ページ番号1 ⇒ "PAGE":5ページ
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO"ではないため、0を指定
obj.settargetpage("FROMTO", 5, 0);

settextcolor(r, g, b) → {Number}

Parameters:

Inherited From:

• pmuobjnote#settextcolor

Returns:

Type

Number

Example

// テキストの色を設定します。
// @param {Number} r 赤値
// @param {Number} g 緑値
// @param {Number} b 青値
// 青色を指定
objnote.settextcolor(0 , 0, 255);

settextsize(size) → {Number}

Parameters:

Inherited From:

• pmuobjnote#settextsize

Returns:

Type

Number

settextstring(str) → {Number}

Parameters:

Inherited From:

• pmuobjnote#settextstring

Returns:

Type

Number

Example

// テキストオブジェクトの文字列を設定します。
// @param {String} str 文字列
objnote.settextstring("注釈追記");

settitle(title) → {Number}

Parameters:

Inherited From:

• pmuobjnote#settitle

Returns:

Type

Number

Example

// 注釈のタイトルを設定します。
// @param {String} title 注釈のタイトル
objnote.settitle("タイトル");

settransparency(transparency) → {Number}

Parameters:

Inherited From:

• pmuobjnote#settransparency

Returns:

Type

Number

setwh(width, height) → {Number}

Parameters:

Inherited From:

• pmuobjnote#setwh

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