Php/docs/function.ps-add-note
From Get docs
ps_add_note
(PECL ps >= 1.1.0)
ps_add_note — Adds note to current page
Description
ps_add_note
( resource $psdoc
, float $llx
, float $lly
, float $urx
, float $ury
, string $contents
, string $title
, string $icon
, int $open
) : bool
Adds a note at a certain position on the page. Notes are like little rectangular sheets with text on it, which can be placed anywhere on a page. They are shown either folded or unfolded. If folded, the specified icon is used as a placeholder.
The note will not be visible if the document is printed or viewed but it will show up if the document is converted to pdf by either Acrobat Distiller™ or Ghostview.
Parameters
psdoc- Resource identifier of the postscript file as returned by ps_new().
llx- The x-coordinate of the lower left corner.
lly- The y-coordinate of the lower left corner.
urx- The x-coordinate of the upper right corner.
ury- The y-coordinate of the upper right corner.
contents- The text of the note.
title- The title of the note as displayed in the header of the note.
icon- The icon shown if the note is folded. This parameter can be set to
comment,insert,note,paragraph,newparagraph,key, orhelp. open- If
openis unequal to zero the note will be shown unfolded after opening the document with a pdf viewer.
Return Values
Returns TRUE on success or FALSE on failure.
See Also
- ps_add_pdflink() - Adds link to a page in a second pdf document
- ps_add_launchlink() - Adds link which launches file
- ps_add_locallink() - Adds link to a page in the same document
- ps_add_weblink() - Adds link to a web location
