8-9 -setTextWatermark:テキスト透かしの挿入

処理内容

文字列を透かしとして挿入します。

コマンド例

[コマンド例の実行内容]

test.pdfに「PDF Tool API V8.0テスト」という文字列をテキスト透かしとして全ページに挿入しout.pdfとして出力する。

テキスト透かしは以下の設定・配置で挿入される。

  • フォント名:メイリオフォント(Windows) / IPAゴシック(Linux)
  • フォントサイズ:52
  • 文字色:{R G B}={1.0, 0.0, 0.0}
  • 透明度0.9
  • 挿入角度20度
  • 配置:ページ中央

[Windows]

AHPDFToolCmd80.exe -setTextWatermark -text "PDF Tool API V8.0 テスト" -colorText 1.0 0.0 0.0 -angle 20 -align 5 -opacity 0.9 -font -name メイリオ -size 52 -d C:\test\test.pdf -o C:\sav\out.pdf

[Linux]

AHPDFToolCmd80 -setTextWatermark -text "PDF Tool API V8.0 テスト" -colorText 1.0 0.0 0.0 -angle 20 -align 5 -opacity 0.9 -font -name ipa-gothic -size 52 -d /home/antenna/test/test.pdf -o /home/antenna/sav/out.pdf

フォルダ指定:対応有り

「-d」のパラメータに入力フォルダを、「-o」のパラメータに出力フォルダを指定して一括処理することができます。

フォルダ指定をされた場合は入力フォルダ内のPDFファイルに対し、文字列を透かしとして挿入します。
なお、出力ファイルは入力ファイル名と同一名で出力フォルダに出力されます。

パラメータ

パラメータ

内容

-text <Val>

[必須]

透かしとして挿入する文字列の設定。

<Val>に設定する文字列にはマクロ文字列も利用可能です。詳細は『10-2 マクロ文字列』を参照してください。

-colorText <r> <g> <b>

省略可。
文字の塗りつぶし色の設定。

設定値の範囲:<r>, <g>, <b>それぞれ0.0~1.0
指定がない場合、黒色(0.0 0.0 0.0)

-colorOutline <r> <g> <b> [*1]

省略可。
文字の輪郭の色の設定。

設定値の範囲:<r>, <g>, <b>それぞれ0.0~1.0
指定がない場合、黒色(0.0 0.0 0.0)

[※「-acrobat」と併用不可]

-diagonal [*1]

指定がある場合、透かしをページの対角線上に挿入する
指定がない場合、透かしは横書き、水平となる。

「-tiling」が設定されている場合は無効
[※「-acrobat」と併用不可]

-angle <Val>

省略可。
透かしの挿入角度を<Val>で設定する。反時計周りが正の値。
指定がない場合、0.0(水平)。
「-diagonal」が設定されている場合は無効。

-rect <left> <bottom> <right> <top> [*1]

省略可。
透かしを配置する矩形の指定(mm単位)。
各要素は左下を(0, 0)とした距離で指定する。指定がない場合はページサイズの矩形。

注意:
<left>に<right>より大きい数値を指定することはできない。<bottom>に<top>より大きい数値を指定することはできない。どちらかで違反した場合はエラーとなる。

[※「-acrobat」と併用不可]

-margin <top> <left> <bottom> <right> [*1]

省略可。
透かしを配置するときの余白の設定(mm単位)。各要素は左下を(0, 0)とした距離で指定する。ページ全体を基準に上下左右それぞれの余白を引いた範囲が指定矩形となる。

注意:
leftとrightの合計値がPDFの幅より大きい場合や、topとbottomの合計値がPDFの高さより大きい場合はエラーとなる。

[※「-acrobat」と併用不可]

-align {1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}

省略可。
透かしの配置場所の設定。指定がない場合は「5:中央」に配置。

1: 左上 2: 中央上 3: 右上
4: 左中 5: 中央 6: 右中
7: 左下 8: 中央下 9: 右下

1~9以外が指定された場合、エラーとなる。

-zorder {1 | 2}

省略可。
透かしのZオーダーの設定。

1: 前面 2: 背面
指定がない場合、「1:前面」に配置。
1,2以外が指定された場合、エラーとなる。

-pageRange {1 | 2 | 3 | 4 | 5}

省略可。
透かしを挿入するページ範囲の設定。指定がない場合、「0:全ページ」に挿入する。

0: 全ページ
1: 先頭ページのみ 2: 最終ページのみ
3: 奇数ページ 4: 偶数ページ
5: 指定したページ

1~5以外が指定された場合、エラーとなる。
1と「-notInFirst」、2と「-notInLast」を指定するとエラーとなる。
「-pageRange 5」を設定した場合は「-pageRangeCustom」が指定必須となる。無い場合はエラーとなる。

-pageRangeCustom <Val> [*2]

[「-pageRange 5」の場合:指定必須]
<Val>には透かしを挿入するページ番号あるいはページ範囲を指定。ページ番号は0オリジン。そのため、1ページ目を「0」から数える。

複数指定する場合はカンマで区切る。

例)-pageRangeCustom “0,2-4”
1ページと3~5ページに挿入される。

[※複数範囲を指定する場合は「-acrobat」と併用不可]

-notInFirst

指定がある場合、先頭ページには透かしを挿入しない。
指定がない場合、先頭ページに透かしを挿入できる。

「-pageRange 1」と同時に指定するとエラーとなる。

-notInLast

指定がある場合、最終ページには透かしを挿入しない。
指定がない場合、最終ページにも透かしを挿入できる。

「-pageRange 2」と同時に指定するとエラーとなる。

-notDisplay

指定がある場合、透かしを表示しない。
指定がない場合、透かしを表示する。

-notPrint

指定がある場合、透かしを印刷対象としない。
指定がない場合、透かしを印刷対象とする。

-opacity <Val>

省略可。
透かしの透明度の設定。指定がない場合、1.0(不透明)。

<Val>の範囲:0.0~1.0。
0.0が透明、1.0が不透明。

-tiling [*1]

指定がある場合、透かしをタイリング挿入する。「-rect」指定があるときは指定した範囲内でタイリングされる。
指定がない場合、透かしをタイリングで挿入しない。

[※「-acrobat」と併用不可]

-acrobat

省略可。
このパラメータが指定された場合、透かしをAcrobat互換のものとして追加する。
指定が無い場合、『PDF Tool API』独自の透かしとして追加する。

[*1]が付いたパラメータと同時指定した場合、および[*2]の条件と合致する場合はエラーとなる。

-font

[Linuxの場合は指定必須]

透かし文字列のフォント設定。[*3]

-name <Val>

[Linuxの場合は指定必須]

フォント名。

Windowsで省略された場合は日本語環境では「MS-Gothic」、それ以外の環境では「Arial」が設定される

-size <Val>

省略可。
フォントサイズ。

単位:point
指定がない場合、24.0 point

-weight <Val>

太さ。省略可。
有効値:200,300,400,500,600,700,800,900
指定がない場合、400
有効値以外が指定された場合、エラー
となる。
-boldの指定があるときは-weightの設定は無効。

-bold

指定がある場合、文字列を太字にする。
指定がない場合、文字列を太字にしない。

-italic

指定がある場合、文字列を斜体にする。
指定がない場合、文字列を正体にする。

-embed {true | false}

省略可。
フォント埋め込み。指定がない場合、「true: 埋め込む」

true: 埋め込む
false: 埋め込まない

Please enter alt text.

[*1]:
「-acrobat」と同時に指定するとエラーとなる。『PDF Tool API』独自の透かし専用パラメータ。

[*2]:
「-pageRangeCustom」でカンマ区切りで複数範囲を指定した場合、「-acrobat」と同時に指定するとエラーとなる。

[*3]:
『PDF Tool API』のコマンドラインアプリケーションにおけるフォント情報の利用や製品仕様に関しては『5-2 フォントについて』を参照してください