ps_add_bookmark
(PECL ps >= 1.1.0)
ps_add_bookmark — Добавляет закладку на текущую страницу
Описание
$psdoc
, string $text
, int $parent = 0
, int $open = 0
) : intДобавляет закладку на текущую страницу. Закладки обычно видны в программах просмотра PDF слева от страницы в иерархическом дереве. Нажатие на закладку открывает страницу, на которую она ссылается.
Примечание не будет отображаться при печати или просмотре документа, но будет показано при конвертировании документа в pdf с помощью Acrobat Distiller™ или Ghostview.
Список параметров
-
psdoc -
Идентификатор ресурса, возвращаемый ps_new(), ссылающегося на postscript-файл..
-
text -
Описание закладки.
-
parent -
Закладка, созданная этой же функцией, которая будет указана в качестве родителя текущей закладки.
-
open -
Если
openне равен нулю, то закладка будет открываться при отображении файла в программе просмотра PDF файлов.
Возвращаемые значения
Возвращаемое функцией значение является ссылкой на закладку. Эта ссылка используется в случае построения иерархии закладок, если нужно указать созданную закладку как родителя. Если функция отработала нормально, возвращаемое значение будет больше нуля. Если функция завершилась с ошибкой, то она вернет ноль.
Смотрите также
- 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