SELFPHP-Druckversion

SELFPHP-Druckversion
Original Adresse dieser Seite:
http://www.selfphp.de/funktionsreferenz/pdf_funktionen/pdf_add_bookmark.php
© 2001-2024

SELFPHP Inh. Damir Enseleit, info@selfphp.de

pdf_add_bookmark

Befehl

int pdf_add_bookmark ( resource pdfdoc, string text, int parent, int open )

Version

(PHP 4 >= 4.0.1, PECL pdflib:1.0-2.1.2)

Beschreibung

Mit pdf_add_bookmark() fügt man innerhalb eines PDF-Dokuments (PDF-Dokument) ein Lesezeichen (Text) für die aktuelle Seite hinzu. Das Lesezeichen funktioniert, ähnlich wie ein Eintrag im Inhaltsverzeichnis, als Sprungmarke zu einer bestimmten Seite. Rückgabewert der Funktion ist die ID des neuen Lesezeichens. Sie können Lesezeichen hierarchisch sortieren. Jeder neuen Hauptgruppe (Mutter) können Sie weitere Untergruppen zuordnen, welche wiederum eigene Untergruppen besitzen können. Eine Untergruppe kann so also auch zu einer Hauptgruppe werden und weitere Lesezeichen umfassen. Wenn Sie ein Lesezeichen oder eine neue Untergruppe anlegen wollen, können Sie im Parameter Mutter die ID der übergeordneten Gruppe angeben, zu der das Lesezeichen bzw. die Untergruppe gehören soll. Sie können mit dem optionalen Parameter offen bestimmen, ob das Inhaltsverzeichnis einer bestimmten Gruppe beim Öffnen des PDF-Dokuments aus- oder eingeklappt sein soll. Soll das Inhaltsverzeichnis ausgeklappt sein, so brauchen Sie nur für offen einen Wert ungleich 0 (Null) angeben. Der optionale Parameter offen ist nur im Zusammenhang mit einer Gruppe (Mutter) erlaubt. Da aber die oberste Hauptgruppe (das erste Lesezeichen) keine "Mutter" besitzt, können Sie einfach einen nicht existenten Rückgabewert (im Beispiel $_x) als Gruppen-ID verwenden. Beim Öffnen des unteren Beispiels klappt die Gruppe "2. Ebene" sofort auf, während die "1. Ebene" geschlossen bleibt.

Siehe auch:

• pdf_add_outline()
• pdf_begin_page()
• pdf_end_page()
• pdf_show_xy()

Beispiel



<?PHP

$ebene1 = '1. Ebene';



$ebene2 = '1.1 Ebene';



$ebene3 = '2. Ebene';



$ebene4 = '2.1 Ebene';



$ebene5 = '2.2 Ebene';



$file = fopen( 'php.pdf', 'w' );



$dokument = pdf_open ( $file );



pdf_begin_page ( $dokument, 200, 100 );



$m1 = pdf_add_bookmark ( $dokument, $ebene1 );



$m2 = pdf_add_bookmark ( $dokument, $ebene2, $m1 );



$m3 = pdf_add_bookmark ( $dokument,$ebene3, $_x, 1 );



$m4 = pdf_add_bookmark ( $dokument, $ebene4, $m3 );



$m5 = pdf_add_bookmark ( $dokument, $ebene5, $m4 );



pdf_end_page ( $dokument );



pdf_close ( $dokument );



fclose ( $file );

?>

Ausgabe

Achtung: Bei der Ausgabe des Befehls wird im Browser nichts zurückgegeben. Die obenstehende Grafik wurde im Acrobat-Reader geöffnet um die Wirkungsweise des Befehls zu zeigen.