ps_add_bookmark

(PECL ps >= 1.1.0)

ps_add_bookmark — Add bookmark to current page

Descrizione

ps_add_bookmark(
    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.

L'annotazione non sarà visibile se il documento è stampato o visualizzato, ma verrà mostrata se il documento è convertito in pdf da Acrobat Distiller™ o Ghostview.

Elenco dei parametri

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.

Valori restituiti

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.

Vedere anche:

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

add a note

User Contributed Notes

There are no user contributed notes for this page.