ps_add_bookmark

(PECL ps >= 1.1.0)

ps_add_bookmark — Додає закладку на поточну сторінку

Опис

ps_add_bookmark(    resource $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() - Додає посилання, яке запускає файл
  • ps_add_pdflink() - Додає посилання на сторінку в іншому PDF-документі
  • ps_add_weblink() - Додає посилання на веб-сторінку