SEL.html

pdf_add_bookmark

Informationsseite

nach unten Befehl
nach unten Version
nach unten Beschreibung
nach unten Beispiel
nach unten Ausgabe

nach unten 

Befehl

int pdf_add_bookmark(int PDF-Dokument, string Text [, int Mutter [, int offen]])

 

nach obennach unten 

Version

PHP 4 >= 4.0.1

 

nach obennach unten 

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:

 

nach obennach unten 

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);
?>

 

nach obennach unten 

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.

 

nach oben
weiter:weiter Seite pdf_add_launchlink
zurück:zurück Seite pdf_add_annotation
 

© 2001, 2002 E-Mail Damir Enseleit, mail@selfphp3.de