ps_add_note

(PECL ps >= 1.1.0)

ps_add_note — 現在のページに注釈を追加する

説明

ps_add_note(
    resource $psdoc,
    float $llx,
    float $lly,
    float $urx,
    float $ury,
    string $contents,
    string $title,
    string $icon,
    int $open
): bool

ページの特定の位置に注釈を追加します。注釈は、 テキストが記入された小さな矩形で、ページ上のどこにでも配置できます。 折りたたんで保持することもでき、折りたたまれている場合は、 指定したアイコンをプレースホルダとして使います。

注釈は、 ドキュメントを印刷したり表示したりするときには表示されません。 しかし、Acrobat Distiller? あるいは Ghostview でドキュメントを pdf に変換すると表示されます。

パラメータ

psdoc

ps_new() が返す、postscript ファイルのリソース ID。

llx

左下角の x 座標。

lly

左下角の y 座標。

urx

右上角の x 座標。

ury

右上角の y 座標。

contents

注釈のテキスト。

title

注釈のヘッダに表示される、タイトル。

icon

注釈が折りたたまれた際に表示されるアイコン。 comment、insert、 note、paragraph、 newparagraph、key あるいは help のいずれかが設定できます。

open

open がゼロでない場合、 PDF ビューア上でドキュメントをオープンすると、 注釈は折りたたまれずに表示されます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

参考

関連キーワード: 　注釈, 追加, ページ, 表示, ドキュメント, float, リンク, 座標, open, string