1PDF::API2::NamedDestinaUtsieorn(C3o)ntributed Perl DocumPeDnFt:a:tAiPoIn2::NamedDestination(3)
2
6 PDF::API2::NamedDestination
7
9 $dest = PDF::API2::NamedDestination->new $pdf
10 $dest = PDF::API2::NamedDestination->new_api $api
11 Returns a destination object. This method is different from 'new'
12 that it needs an PDF::API2-object rather than a
13 PDF::API2::PDF::File-object.
14 $dest->link $page, %opts
16 Defines the destination as launch-page with page $page and options
17 %opts (-rect, -border or 'dest-options').
18 $dest->url $url, %opts
20 Defines the destination as launch-url with url $url and options
21 %opts (-rect and/or -border).
22 $dest->file $file, %opts
24 Defines the destination as launch-file with filepath $file and
25 options %opts (-rect and/or -border).
26 $dest->pdfile $pdfile, $pagenum, %opts
28 Defines the destination as pdf-file with filepath $pdfile, $pagenum
29 and options %opts (same as dest).
30 $dest->dest( $page, -fit => 1 )
32 Display the page designated by page, with its contents magnified
33 just enough to fit the entire page within the window both
34 horizontally and vertically. If the required horizontal and
35 vertical magnification factors are different, use the smaller of
36 the two, centering the page within the window in the other
37 dimension.
38 $dest->dest( $page, -fith => $top )
40 Display the page designated by page, with the vertical coordinate
41 top positioned at the top edge of the window and the contents of
42 the page magnified just enough to fit the entire width of the page
43 within the window.
44 $dest->dest( $page, -fitv => $left )
46 Display the page designated by page, with the horizontal coordinate
47 left positioned at the left edge of the window and the contents of
48 the page magnified just enough to fit the entire height of the page
49 within the window.
50 $dest->dest( $page, -fitr => [ $left, $bottom, $right, $top ] )
52 Display the page designated by page, with its contents magnified
53 just enough to fit the rectangle specified by the coordinates left,
54 bottom, right, and top entirely within the window both horizontally
55 and vertically. If the required horizontal and vertical
56 magnification factors are different, use the smaller of the two,
57 centering the rectangle within the window in the other dimension.
58 $dest->dest( $page, -fitb => 1 )
60 (PDF 1.1) Display the page designated by page, with its contents
61 magnified just enough to fit its bounding box entirely within the
62 window both horizontally and vertically. If the required horizontal
63 and vertical magnification factors are different, use the smaller
64 of the two, centering the bounding box within the window in the
65 other dimension.
66 $dest->dest( $page, -fitbh => $top )
68 (PDF 1.1) Display the page designated by page, with the vertical
69 coordinate top positioned at the top edge of the window and the
70 contents of the page magnified just enough to fit the entire width
71 of its bounding box within the window.
72 $dest->dest( $page, -fitbv => $left )
74 (PDF 1.1) Display the page designated by page, with the horizontal
75 coordinate left positioned at the left edge of the window and the
76 contents of the page magnified just enough to fit the entire height
77 of its bounding box within the window.
78 $dest->dest( $page, -xyz => [ $left, $top, $zoom ] )
80 Display the page designated by page, with the coordinates (left,
81 top) positioned at the top-left corner of the window and the
82 contents of the page magnified by the factor zoom. A zero (0) value
83 for any of the parameters left, top, or zoom specifies that the
84 current value of that parameter is to be retained unchanged.
85
87 Alfred Reibenschuh
88perl v5.12.2 2011-01-24 PDF::API2::NamedDestination(3)