SEL.html

pdf_add_outline

Informationsseite

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

nach unten 

Befehl

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

 

nach obennach unten 

Version

PHP 3 >= 3.0.6, PHP 4 >= 4.0b1

 

nach obennach unten 

Beschreibung

Mit pdf_add_outline() 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 aber 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 "PHP3/4" sofort auf,
während "Referenz" geschlossen bleibt. Sobald Sie aber auf "Referenz" klicken,
öffnet sich sofort die ganze Gruppenstruktur von "Referenz".

Siehe auch:

 

nach obennach unten 

Beispiel

<?PHP
$file = fopen("php.pdf", "w");
$dokument = pdf_open($file);
pdf_begin_page($dokument,250, 150);
$_1 = pdf_add_outline($dokument,"PHP3/4",$_x,1);
pdf_add_outline($dokument,"PHP3",$_1);
pdf_add_outline($dokument,"PHP4",$_1);
pdf_set_font($dokument, "Times-Roman", 14, "winansi");
$_2 = pdf_add_outline($dokument,"Referenz");
pdf_show_xy($dokument,"Text.......",30,130);
pdf_end_page($dokument);
pdf_begin_page($dokument,250, 150);
pdf_set_font($dokument, "Times-Roman", 14, "winansi");
$_2_1 = pdf_add_outline($dokument,"Grafik",$_2,1);
pdf_show_xy($dokument,"Text.......",30,130);
pdf_end_page($dokument);
pdf_begin_page($dokument,250, 150);
pdf_set_font($dokument, "Times-Roman", 14, "winansi");
$_2_1_1 = pdf_add_outline($dokument,"PDF-Funktionen",$_2_1);
pdf_show_xy($dokument,"Text.......",30,130);
pdf_end_page($dokument);
pdf_begin_page($dokument,250, 150);
pdf_set_font($dokument, "Times-Roman", 48, "winansi");
pdf_add_outline($dokument,"Image-Funktionen",$_2_1);
pdf_show_xy($dokument,"Text.......",30,100);
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_pdflink
zurück:zurück Seite pdf_add_note
 

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