ps_add_bookmark
(PECL ps >= 1.1.0)
ps_add_bookmark — Add bookmark to current page
說明
resource
$psdoc
,string
$text
,int
$parent
= 0,int
$open
= 0): int
Adds a bookmark for the current page. Bookmarks usually appear in PDF-Viewers left of the page in a hierarchical tree. Clicking on a bookmark will jump to the given page.
此說明在文件被列印或顯示時不可見,只在文件用 Acrobat Distiller 或 Ghostview 轉換成 PDF 時顯示。
參數
-
psdoc
-
Resource identifier of the postscript file as returned by ps_new().
-
text
-
The text used for displaying the bookmark.
-
parent
-
A bookmark previously created by this function which is used as the parent of the new bookmark.
-
open
-
If
open
is unequal to zero the bookmark will be shown open by the pdf viewer.
返回值
The returned value is a reference for the bookmark. It is only used if the bookmark shall be used as a parent. The value is greater zero if the function succeeds. In case of an error zero will be returned.
參見
- ps_add_launchlink() - Adds link which launches file
- ps_add_pdflink() - Adds link to a page in a second pdf document
- ps_add_weblink() - Adds link to a web location